Payment status
A PaysafeCash payment can progress through the following states during its lifecycle:
| Value | Description |
|---|---|
INITIATED | The initial state of a payment after it has been successfully created. |
REDIRECTED | The customer has reached the barcode panel. |
AUTHORIZED | The customer has paid the transaction amount at a payment point. |
SUCCESS | The payment has been completed successfully. |
CANCELED_CUSTOMER | The customer has cancelled the payment. |
CANCELED_MERCHANT | The business partner has cancelled the payment. |
EXPIRED | The customer has not paid the transaction within the predefined time frame, which is 72 hours by default. |
HTTP status codes
| Code | Short Description | Description |
|---|---|---|
200 | OK | Everything is OK. |
201 | Created | A new object was successfully created. |
400 | Bad Request | A required parameter is missing or invalid. |
401 | Unauthorized | The API key is invalid or expired. |
404 | Not Found | The requested resource was not found. This response is also returned when retrieving a payment that does not exist. |
500 | Internal Server Error | A general technical error occurred on the PaysafeCash side. |
501 | Not Implemented | The requested version or feature is not implemented. |
502 | Bad Gateway | An invalid response was received from an upstream system. |
503 | Service Unavailable | The server is temporarily unavailable or overloaded. |
504 | Gateway Timeout | A timeout occurred while waiting for an upstream system. |
Below is an example of an error response:
{
"code": "invalid_request_parameter",
"message": "must contain 1-10 digits, followed by a decimal separator '.' followed by 2 digits",
"number": 10028,
"param": "amount"
}
Customer ID
Also known as the Merchant Client ID, the customer ID is an important parameter for the PaysafeCash integration.
The customer ID identifies the customer in the business partner's system.
The recommended customer ID is a completely random value that uniquely identifies the customer and is not connected to any personal information.
The same value should be used for all transactions associated with the customer.
Valid values
| Value | Type |
|---|---|
2c3be0b50c7a5f1964a63d78f38a6ffc41c027e9 | SHA-1 hash of test@123.com |
742f2b1a55cd5d606ea44b4fcb54646a | MD5 hash of test@123.com |
3a5b0d0777dead9df93d502df85c8180e53804eb | SHA-1 hash of UsernameValue1 |
3192481752123 | Random customer identifier |
CustomerID1 | Customer identifier without personal information |
Invalid values
test@123.comUsername_1FirstName123LastName123TimestampIP Address
Sending any of these invalid values will not be accepted.
If payments are processed across multiple brands, contact PaysafeCard to discuss options for separating multiple entities within the account.
Variable Transaction Timeout
When the barcode is created, the customer is given a specific period in which to visit a payment point and pay for the transaction.
This period begins when the transaction is created and ends when the transaction expires if no payment is completed.
The default period is 72 hours. The barcode application displays the remaining time available to complete the payment.
The timeout can be configured for each transaction in the initiate payment request by using the expiration_time_minutes parameter.
The accepted value for this parameter is between 5 and 20160 minutes. If no value is specified, the default timeout is used.