Skip to main content

InitiatePayment

typestringrequired

Payment type

Example: PAYSAFECARD
amountnumber<float>required

Payment amount

Example: 10.01
currencystringrequired

ISO 4217 (3 letter ISO currency code)

Example: EUR
redirect objectrequired

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

success_urlstring<uri>required

Customer redirected after successful completion of the transaction.

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

Customer redirected after cancelling transaction on payment panel (Customer clicking on X).

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

URL to be used by PaysafeCard to notify you once the customer has paid using PaysafeCard PIN or account.

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
min_agenumber

Valid for PaysafeCard account payments. Restricts payments to PaysafeCard account customers only, who are equal to or older than the specified age. Please note that this means that it is required that the customer has a registered PaysafeCard account to make the payment.

Example: 18
kyc_levelstring

Valid values are SIMPLE or FULL.

Possible values: [SIMPLE, FULL]

Example: FULL
country_restrictionstring

ISO 3166-1 alpha-2 two-letter country code used to restrict payments to residents of a particular country.

Example: AT
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
InitiatePayment
{
"type": "PAYSAFECARD",
"amount": 10.01,
"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",
"min_age": 18,
"kyc_level": "FULL",
"country_restriction": "AT"
},
"submerchant_id": "SUBM1234",
"shop_id": "Shop_ABC"
}