Skip to main content

RetrievePaymentResponse

Represents the response returned after creating, retrieving or capturing a payment

objectstringrequired

Object type identifier

Example: PAYMENT
idstringrequired

Unique identifier of the payment

Example: pay_9000001500_jLN9657f9uLNxSbXdhMmndw54N66W8Ea_EUR
createdinteger<int64>required

Unix timestamp in milliseconds when the payment was created

Example: 1781006255231
updatedinteger<int64>required

Unix timestamp in milliseconds of the last update

Example: 1781006255231
currencystringrequired

ISO 4217 (3 letter ISO currency code)

Example: EUR
statusstringrequired

Represents the current status of the payment.

  • INITIATED: The payment has been successfully created.
  • REDIRECTED: The customer has been redirected to the Payment Panel.
  • AUTHORIZED: The customer has successfully completed the payment authorization.
  • SUCCESS: The payment has been successfully captured.
  • EXPIRED: The payment was not completed within the allowed time window, either due to customer inaction or failure to capture the payment.
Example: AUTHORIZED
status_before_expirationstring

Holds the status of the payment before it transitioned to EXPIRED. This is useful to distinguish cases where a successfully authorized payment has not been captured from cases where a customer did not authorize the payment at all. Optional. Only returned when the payment is in status EXPIRED

Example: AUTHORIZED
typestringrequired

Payment method type

Example: PAYSAFECARD
amountnumber<float>required

Payment amount

Example: 0.01
notification_urlstring<uri>required

URL where payment notifications are sent

Example: https://paymentnotification.site/example
customer objectrequired

Customer associated with the payment

idstringrequired

Merchant customer identifier

Example: TestUser123
ipstring

IPv4 address of the customer. Can only be returned after customer has been re-directed to PaysafeCards payment panel.

Example: 134.238.250.192
emailstring<email>

Customer's PaysafeCard account email. Returned when the Customer Data Exchange feature is enabled.

Example: customer@example.com
psc_idinteger<int64>

Customer's 12-digit PaysafeCard account identifier. Returned when the Customer Data Exchange feature is enabled.

Example: 736489412559
first_namestring

Customer's first name. Returned when the Customer Data Exchange feature is enabled.

Example: Test
last_namestring

Customer's last name. Returned when the Customer Data Exchange feature is enabled.

Example: Customer
date_of_birthstring<date>

Customer's date of birth. Returned when the Customer Data Exchange feature is enabled.

Example: 1994-11-13
account_createdstring

PaysafeCard account creation timestamp in yyyy-MM-dd HH:mm:ss format. Returned when the Customer Data Exchange feature is enabled.

Example: 2024-11-13 10:11:06
redirect objectrequired

Redirect URLs and authorization URL for the payment flow

success_urlstring<uri>required

URL where the customer is redirected after successful authorization

Example: https://www.guinbox.com/notes/uC5lKyzh74x
failure_urlstring<uri>required

URL where the customer is redirected if the payment fails

Example: https://www.guinbox.com/notes/FP8gU99Wj7u
auth_urlstring<uri>required

URL where the customer must be redirected to authorize the payment

Example: https://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet?mid=9000001500&mtid=pay_9000001500_jLN9657f9uLNxSbXdhMmndw54N66W8Ea_EUR&amount=0.01&currency=EUR
payment_instrumentstring

The type of payment, i.e. paysafecard, giftcard, pagoefectivo or safetypay. It is optional and can be enabled by Paysafe. Can only be returend after the customer has paid.

Example: paysafecard
payment_instrument_subtypestring

The way the payment was done. i.e. using code or account. It is optional and can be enabled by Paysafe. Can only be returend after the customer has paid.

Example: account
submerchant_idstring

Identifier of the submerchant

Example: SUBM1234
RetrievePaymentResponse
{
  "object": "PAYMENT",
  "id": "pay_9000001500_jLN9657f9uLNxSbXdhMmndw54N66W8Ea_EUR",
  "created": 1781006255231,
  "updated": 1781006255231,
  "currency": "EUR",
  "status": "AUTHORIZED",
  "status_before_expiration": "AUTHORIZED",
  "type": "PAYSAFECARD",
  "amount": 0.01,
  "notification_url": "https://paymentnotification.site/example",
  "customer": {
    "id": "TestUser123",
    "ip": "134.238.250.192",
    "email": "customer@example.com",
    "psc_id": 736489412559,
    "first_name": "Test",
    "last_name": "Customer",
    "date_of_birth": "1994-11-13",
    "account_created": "2024-11-13 10:11:06"
  },
  "redirect": {
    "success_url": "https://www.guinbox.com/notes/uC5lKyzh74x",
    "failure_url": "https://www.guinbox.com/notes/FP8gU99Wj7u",
    "auth_url": "https://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet?mid=9000001500&mtid=pay_9000001500_jLN9657f9uLNxSbXdhMmndw54N66W8Ea_EUR&amount=0.01&currency=EUR"
  },
  "payment_instrument": "paysafecard",
  "payment_instrument_subtype": "account",
  "submerchant_id": "SUBM1234"
}