APMs Overview

Paysafe's Alternate (or Alternative) Payments API can be used to take payments using a number of alternative payment methods popular in countries around the world. This API currently supports the payment methods in the table below.

You can enable only one alternative payment method per account associated with your merchant account. Each of these accounts must have an associated settlement currency. If you need to use the same alternative payment method with multiple settlement currencies (where available) then you will need a separate account configured for each currency/payment method combination.

One step payment gateway refers to payment integrations where authorization / capture of funds occur at the same time. This is fairly common for many alternative payment methods where the customer authenticates and authorizes the payment through a channel provided by the PSP. Typically, once the customer has authorized the payment, funds are immediately allocated and confirmed by the PSP.

• Only supports settleWithAuth=true
• For these integrations, corresponding Payment and Settlement resources are created simultaneously to represent the transaction. Both resources utilize the same unique GUID as are created from the same request. For these integrations, the Payment should reflect the same status as the Settlement and can be used to indicate success or failure of the transaction request without having to do a separate lookup on the specific settlement.

Two step payment gateway refers to payment integrations where the authorization (Payment) and capture (Settlement) are performed as 2 unique steps.

• May support both settleWithAuth=true and settleWithAuth=false options.
• Paysafe may optionally offer auto settlement and support the settleWithAuth=true option (dependent upon the payment type). In this scenario, Paysafe will attempt to issue the settlement call on your behalf. For these integrations, the Payment status is used to reflect if the request has been authorized by the customer with the PSP. For these integrations, regardless of whether manual or automatic settlement is selected, the merchant must separately check the status of the Settlement in order to confirm funds have been properly transitioned before releasing goods/services to the customer

The standard payment flow (automatic settlement) is summarized in the following diagram:

1. The customer is ready to check out and selects an alternate payments method.
2. The merchant sends a Payment request using the Paysafe Alternate Payments API.
3. If the request is successful, Paysafe returns a response that includes a payment ID and a payment redirect URL hosted by the payment provider.
4. The merchant redirects the customer's browser to the payment provider URL.
5. The customer logs in and authorizes the payment.
6. Once payment authorization is complete (or fails), the customer is redirected back to the return URL provided by the merchant in the payment request.
7. Paysafe receives updates from the payment provider on the status of the request.
8. The merchant should use webhooks for notification of status changes.
9. For 1-step gateways, once the payment is complete, the merchant receives the funds and they can notify the customer. For 2-step gateways, once the settlement is complete, the merchant receives the funds and they can notify the customer.

NOTE: Some payment methods do not require a redirect. In this case, no redirect link is returned.

Some payment methods offer manual settlement, which allows the merchant to authorize a payment and then settle at a later date/time, typically on shipment of goods. This behavior is controlled using the settleWithAuth parameter.

NOTE: When settling paysafecard payment authorizations, the maximum delay between the initial payment authorization and the subsequent settlement is 1 minute.

The manual settlement payment flow is summarized in the following diagram:

1. The customer is ready to check out and selects a two-step alternate payments method (e.g., paysafecard).
2. The merchant sends a Payment request using the Paysafe Alternate Payments API, with the settleWithAuth parameter set to false.
3. If the request is successful, Paysafe returns a response that includes a payment ID and a payment redirect URL hosted by the payment provider.
4. The merchant redirects the customer's browser to the payment provider URL.
5. The customer logs in and authorizes the payment request, which will not be settled at this point.
6. Once payment request is completed (or fails), the customer is redirected back to the return URL provided by the merchant in the payment request.
7. Paysafe receives updates from the payment provider on the status of the request.
8. The merchant can use webhooks to receive notification of status changes.
9. If the merchant is ready to ship the goods or provide the digital content, they send a Settlement request for the payment.
10. Paysafe returns a response to the Settlement request.
11. When the Settlement is complete, the merchant receives the funds and they can ship the goods and notify the customer.

NOTE: Multiple partial settlements are supported with a cumulative value equal to the initial authorization. The amount remaining to settle, if any, is shown in the response to each Settlement request.