Paysafecash

The Paysafe Payments API supports Paysafecash as a Payment Instrument. You can process paysafecash payments using the Payments API.

The Payments API caters to the following needs for Paysafecash:

• Payment Instrument: Paysafecash

• Payment method: Online payments with cash

• Transaction types: Payments

• Payment authentication: API key for request authentication, Authorization of the payment server IP address, X.509 certificate for request authenticity

When you want to process a payment request using Paysafecash as the payment type, you would do the following:

1. Create a Payment Handle with the transactionType parameter set to PAYMENT and the paymentType parameter set to PAYSAFECASH.
2. Since the customer has to complete payment authentication by providing Paysafecash details, Paysafe returns a response with the following:
   • The action parameter is set to REDIRECT
   • A payment_redirect link points to the Paysafecash redirect URL
3. Redirect the customer to the Paysafecash redirect URL so they can generate a bar code.
4. Upon successful bar-code generation, the status of the Payment Handle becomes PAYABLE. The merchant gets notified of this status change via webhooks that have been configured.
5. Use the paymentHandleToken returned in the response to process the Payment request. The Payment will have a status of PENDING until the customer has made the payment.

Once the Payment request is successfully completed, the merchant gets notified via webhooks and the funds are immediately transferred to the merchant's account.

Paysafecash Payment - Redirection Flow

1. When processing a payment request with Paysafecash as the payment type, perform the following steps:

2. Create a Payment Handle with the transactionType parameter set to PAYMENT and the paymentType parameter set to PAYSAFECASH.

3. Paysafe provides the following response since the customer must complete payment authentication by entering Paysafecash details:

   • The action parameter is set to REDIRECT

   • A payment_redirect link points to the Paysafecash redirect URL

4. Redirect the customer to the Paysafecash redirect URL in order for them to generate a barcode.

5. The Payment Handle status changes to PAYABLE after successful barcode generation. This status update is communicated to the merchant using webhooks that have been configured.

6. To process the Payment request, use the paymentHandleToken supplied in the response. The Payment will have a status of PENDING until the customer has made the payment.

Once the Payment request is successfully completed, the merchant gets notified via webhooks and the funds are immediately transferred to the merchant's account.

Paysafecash Payment - Direct Flow

When processing a payment request using Paysafecash as the payment type, perform the following steps:

1. Create a Payment Handle with the transactionType parameter set to PAYMENT and the paymentType parameter set to PAYSAFECASH.

2. Paysafe returns a response with the following barcodes array and Payment Handle status as PAYABLE.

     3. Display the Barcode to the user.

     4. To complete the Payment request, use the paymentHandleToken returned in the response. The status of the payment will be PENDING until the customer makes the payment in-store.

Available for both direct and redirect flow.

To cancel a barcode, perform the following steps:

1. Create a PUT HTTP call with Payment ID in the URL:
   
   PUT/paymenthub/v1/payments/{paymentId}

2. Pass below JSON in request body:
   
   {
        "status": "CANCELLED"
   }

3. You will receive response with status CANCELLED.

4. You can check Payment status using GET call:
   
   GET/paymenthub/v1/payments/{paymentId}

Store Locator API

To fetch Paysafe Stores:

• Create a GET call with the following parameters.
  
  You will get a store list in the response.

Test Customer Id Values

Customer ID is also known as "Merchant Client ID", is an important parameter for the integration of paysafecard. The Customer ID identifies the Customer on our business partners side. The most optimal customer ID is a completely random value. A value that uniquely identifies the customer and is disconnected from any personal information. This customer ID value should be the same for all transactions of the customer. Here are Guidelines for possible Customer IDs:

Valid Values:

Invalid Values

Sending any form of the invalid values will not be accepted. If you intend to process paysafecard transactions on multiple brands, please inquire about the possibilities of separating multiple entities for your account.