Skip to main content

Payshop logo

Payshop is an alternative payment method exclusive to Portugal which allows you to make payments in more than 5000 authorized merchants. All you have to do is enter the 13-digit reference number and hand over the cash to complete the purchase.

There are two ways to integrate it: by redirection or push payment.

Integration by redirection​

To integrate by redirection, the user must be present at the time of payment, which must be processed through a browser. First we must generate a payment order.

As service identifier, the service_uuid of the PAYSHOP service you have activated in your Paylands Backend → Manage → Payment Services → Listing must be indicated.

Once the order is generated, the user must be redirected to the payment screen indicating the token of the order and in the query, the name of the APM:

We construct the redirection URL by replacing the token with the value returned in the previous call.

https://api.paylands.com/v1/sandbox/payment/process/{token}?apm=PAYSHOP

Once the user is redirected to this screen, he/she will be able to view the reference to be entered through his/her bank's mobile application or physically through an ATM. When the payment is completed, he/she will be redirected back to the OK or KO URL, depending on the result of the payment.

Push payment integration​

If the merchant prefers to send the reference to the user through a channel other than the browser, it is possible to integrate the push payment method, which will return the reference to the server so that it can be sent to the user.

To do this, we must first generate a payment order.

Then we must launch the push payment request indicating the UUID of the order. The response will contain the payment reference and payment deadline. These fields are included within the payment transaction, in the field payment_data. An example is included below:

"payment_data": {
    "reference": "1234500001411",
    "deadline": "2024-05-03"
}

Once the payment is completed, the merchant will receive the payment notification to the URL indicated in the `url_postundefined field when generating the payment order.

Testing​

For more information on how to test this payment method, visit the PAYSHOP documentation.

Custom fields​

By default, the expiration date is set within 3 days from the moment the payment is triggered. If you want to customize this value, just add the following information when generating the payment order indicating with the desired date in Ymd format. Its value must be equal to or greater than the current date:

"extra_data": {
    "payment": {
        "validUntil": "20240520"
    }
}

You can also specify the maximum number of payments that can be made with the same reference by specifying the maxNbrPayments field. Its value must be 1 or higher.

"extra_data": {
    "payment": {
        "maxNbrPayments": "3"
    }
}
```