Skip to main content

InitiatePaymentConsentZeroAmount

typestringrequired

Payment type

Example: PAYSAFECARD
amountnumber<float>required

The amount should be 0 as we do not want to additionally initate a financial transaction. We only need to obtain the customer's consent to be able and initiate automated payments in the future.

Example: 0
currencystringrequired

ISO 4217 (3 letter ISO currency code)

Example: EUR
redirect objectrequired

URLs to redirect after successful completion or cancellation of the transaction.

success_urlstring<uri>required

Customer redirected after giving consent.

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

Customer redirected for cancelling the transaction.

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

URL to be used by PaysafeCard to notify you once the customer has given the consent.

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

Details and/or restriction for the customer are provided in this object

idstringrequired

Merchant customer identifier

Example: TestUser123
submerchant_idstring

Submerchant identifier

Example: SUBM1234
shop_idstring

Identification of the shop which is the originator of the request. This is most likely used by payment service providers who act as a proxy for other payment methods as well.

Example: Shop_ABC
InitiatePaymentConsentZeroAmount
{
  "type": "PAYSAFECARD",
  "amount": 0,
  "currency": "EUR",
  "redirect": {
    "success_url": "https://www.guinbox.com/notes/uC5lKyzh74x",
    "failure_url": "https://www.guinbox.com/notes/FP8gU99Wj7u"
  },
  "notification_url": "https://paymentnotification.site/example",
  "customer": {
    "id": "TestUser123"
  },
  "submerchant_id": "SUBM1234",
  "shop_id": "Shop_ABC"
}