Skip to main content

CancelPaymentResponse

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_joIPoYytTknho4TYelkmKd69vf4y3oHt_EUR
createdinteger<int64>required

Unix timestamp in milliseconds when the payment was created

Example: 1781095664585
updatedinteger<int64>required

Unix timestamp in milliseconds of the last update

Example: 1781095680957
currencystringrequired

ISO 4217 (3 letter ISO currency code)

Example: EUR
statusstringrequired

Represents the current status of the payment.

  • CANCELED_MERCHANT: The payment has been successfully cancelled by the merchant.
Example: CANCELED_MERCHANT
typestringrequired

Payment method type

Example: PAYSAFECARD
amountnumber<float>required

Amount of the payment.

Example: 0
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
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
CancelPaymentResponse
{
  "object": "PAYMENT",
  "id": "pay_9000001500_joIPoYytTknho4TYelkmKd69vf4y3oHt_EUR",
  "created": 1781095664585,
  "updated": 1781095680957,
  "currency": "EUR",
  "status": "CANCELED_MERCHANT",
  "type": "PAYSAFECARD",
  "amount": 0,
  "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",
  "card_details": {
    "serial": 9900990,
    "currency": "EUR",
    "type": 2,
    "country": "AT"
  }
}