Skip to main content

PaysafeCash POS cashout API information


Transaction status

ValueDescription
INITIATEDThe initial state of a transaction after it has been successfully created.
AUTHORIZEDThe customer has completed the transaction at a payment point.
SUCCESSThe transaction has been completed successfully.
CANCELED_MERCHANTThe transaction has been cancelled by the business partner.
EXPIREDThe customer has not logged in to the barcode application for 30 minutes, the business partner has not generated the barcode after the transaction has been created, or the customer has not completed the transaction at a payment point in the predefined time frame (default 24 hours, unless specified otherwise by the business partner).

HTTP status codes

CodeShort descriptionDescription
200OKThe request was successful.
201CreatedObject successfully created.
400Bad RequestInvalid data provided in the request.
401UnauthorizedInvalid or expired API key.
404Not FoundPOS cashout feature disabled.
500Internal Server ErrorA general technical error on PaysafeCard's end.
501Not ImplementedVersion feature not implemented.
502Bad GatewayInvalid response from upstream system.
503Service UnavailableServer overloaded.
504Gateway TimeoutTimeout from upstream system.

Example error response:

400 Bad Request

{
"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 Merchant Client ID, the customer id identifies the customer on the business partner's side.

The most optimal customer id is a completely random value that uniquely identifies the customer and is disconnected from any personal information. This value should be the same for all transactions of the customer.

Valid values:

ValueType
2c3be0b50c7a5f1964a63d78f38a6ffc41c027e9SHA1 - test@123.com
742f2b1a55cd5d606ea44b4fcb54646aMD5 - test@123.com
3a5b0d0777dead9df93d502df85c8180e53804ebSHA1 - UsernameValue1
3192481752123Random customer identifier
CustomerID1Customer identifier free of personal information

Invalid values:

  • test@123.com
  • Username_1
  • FirstName123
  • LastName123
  • Timestamp
  • IP Address

Sending any form of the invalid values will not be accepted.

If you intend to process transactions on multiple brands, please inquire about the possibilities of separating multiple entities for your account.