Skip to main content

CapturePaymentResponse

Represents the response returned after cancelling 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.

  • SUCCESS: The payment has been successfully captured.
Example: SUCCESS
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
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
submerchant_idstring

Identifier of the submerchant

Example: SUBM1234
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
card_details objectrequired

Provides details over the PaysafeCard PINs used.

serialnumberrequired

Provides the serial number of the PaysafeCard PIN used to pay. Insensitive payment information that helps customer care investigate.

Example: 9900990
currencystringrequired

ISO 4217 (3 letter ISO currency code)

Example: EUR
typestringrequired

Card type identifier of the PaysafeCard PIN used in the payment

Example: 2
countrystringrequired

Country where the PaysafeCard PIN was sold, as a 2 letter ISO country code.

Example: AT
CapturePaymentResponse
{
  "object": "PAYMENT",
  "id": "pay_9000001500_jLN9657f9uLNxSbXdhMmndw54N66W8Ea_EUR",
  "created": 1781006255231,
  "updated": 1781006255231,
  "currency": "EUR",
  "status": "SUCCESS",
  "type": "PAYSAFECARD",
  "amount": 0.01,
  "notification_url": "https://paymentnotification.site/example",
  "customer": {
    "id": "TestUser123",
    "ip": "134.238.250.192"
  },
  "redirect": {
    "success_url": "https://www.guinbox.com/notes/uC5lKyzh74x",
    "failure_url": "https://www.guinbox.com/notes/FP8gU99Wj7u"
  },
  "submerchant_id": "SUBM1234",
  "payment_instrument": "paysafecard",
  "payment_instrument_subtype": "account",
  "card_details": {
    "serial": 9900990,
    "currency": "EUR",
    "type": 2,
    "country": "AT"
  }
}