PayPo for API only

Accept PayPo payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Requirements

Build your payment form for PayPo

Include PayPo in the list of available payment methods.

In your /paymentMethods request, specify:

• countryCode: PL
• amount.currency: PLN

Make a payment

In your /payments request, specify:

Parameter name	Required	Description
paymentMethod.type		paypo
returnUrl		The URL the shopper is redirected back to after they complete the payment. This URL can have a maximum of 1024 characters.
shopperEmail		The shopper's email address.
shopperName		The shopper's name.
billingAddress		The shopper's billing address.
deliveryAddress		The delivery address for the goods purchased.

In the  /payments response, note the `action` object. This contains the information needed to redirect the shopper.

<div data-component-wrapper="code-sample">
<code-sample
    :title="'/payments response'"
    :id="''"
    :code-data="[{&quot;language&quot;:&quot;json&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;{\n   \&quot;resultCode\&quot;:\&quot;RedirectShopper\&quot;,\n   \&quot;action\&quot;:{\n      \&quot;paymentMethodType\&quot;:\&quot;paypo\&quot;,\n      \&quot;method\&quot;:\&quot;GET\&quot;,\n      \&quot;url\&quot;:\&quot;https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/checkoutPaymentRedirect?redirectData=...\&quot;,\n      \&quot;type\&quot;:\&quot;redirect\&quot;\n   }\n}&quot;}]"
    :enable-copy-link-to-code-block="true"
    :code-sample-card-size="'fullsize'"
></code-sample>

Handle the redirect

1. To complete the payment, redirect the shopper to the action.url returned in the /payments response, taking into account the following recommendations:

   • When using the HTTP GET method:
     For security reasons, when showing the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

   • Redirection for mobile integrations:
     For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.

2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

   • details: object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.

3. In the response note the following:

   • resultCode: use this to present the result to your shopper.
   • pspReference: our unique identifier for the transaction.

Show the payment result

Use the resultCode that you received in the /payments/details response to show your shopper the payment result.

The resultCode values you can receive for PayPo are:

If the shopper fails to return to your website or app, wait for webhooks to know the outcome of the payment:

Capture the payment

When a payment is made, but not yet authorized, the offer will be available for up to 72 hours. Therefore, the shopper can use the link to the payment for up to 72 hours.

When the payment is accepted by the shopper, its status will change to Authorised. The shopper has 30 days to pay according to the terms of PayPo. This is different to some other payment methods where the payment term usually starts after the capture, not after the authorization.

After the payment is authorized, you also have to capture the payment.

• It is only possible to capture the full amount of the authorized payment.
• It is possible to configure an automatic capture, which executes immediately after authorization. Configure automatic capture when adding PayPo in your live Customer Area.
• The merchant does not have to wait for the shopper to complete their payment to PayPo to be funded for the transaction. After the payment is captured, the merchant is funded the full amount of the payment. This is because the capture is only possible for the full amount.

• To perform the capture, send a request to /payments/{paymentPspReference}/captures using the PSP Reference of the original payment:

Cancel a payment

When a payment is authorized, PayPo opens a credit line for the shopper. The shopper is expected to pay PayPo's invoice within 30 days. If you cannot fulfill the order, you are advised to cancel the payment.

To cancel an authorized payment, perform a cancel request using the pspReference of the original payment.

Test and go live

When you test PayPo in your test environment, use the following values for the required parameters:

firstName: name
lastName: surname
shopperEmail: email@gmail.com

When you are redirected to PayPo and asked for a verification code, use 123456.

Check the status of PayPo test payments in your Customer Area > Transactions > Payments.

Before you can accept live PayPo payments, you need to submit a request for PayPo in your live Customer Area.

See also