No momento, esta página não está disponível em português
Payment-method icon

PayPo for API only

Add PayPo to an existing API-only integration.

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.

Before you begin

These instructions explain how to add PayPo to your existing API-only integration.

Before starting your PayPo integration:

  1. Make sure that you have set up your back end implementation.
  2. Add Online banking Poland in your test Customer Area.

Build your payment form for PayPo

Include PayPo in the list of available payment methods.

In your /paymentMethods request, specify:

Make a payment

In your /payments request, specify:

Parameter name Required Description
paymentMethod.type -white_check_mark- paypo
returnUrl -white_check_mark- The URL the shopper is redirected back to after they complete the payment. This URL can have a maximum of 1024 characters.
shopperEmail -white_check_mark- The shopper's email address.
shopperName -white_check_mark- 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.

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.

    When using the HTTP GET method:
    For security reasons, when displaying 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.

  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:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
You will receive the funds in 2-3 days.
Cancelled The shopper cancelled the payment while on their bank's website. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error There was an error when the payment was being processed. Inform the shopper that there was an error processing their payment. You'll receive a refusalReason in the same response, indicating the cause of the error.
Pending or
The shopper has completed the payment but the final result is not yet known. Inform the shopper that you've received their order, and are waiting for the payment to be completed.
You will receive the final result of the payment in an AUTHORISATION webhook.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.

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

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment is successful and proceed with the order.

Test and go live

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

firstName: name
lastName: surname

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