InitiatePaymentToken

typestringrequired

Payment type

Example: PAYSAFECARD

amountnumber<float>required

The amount of the automated transaction.

Example: 0.01

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 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

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

payment_tokenstringrequired

The token received for automated payments for the customer.

Example: spi_ZmBMcOQNuH3dRTeDReSZBjLIbb

expiration_time_minutesnumber<integer>

Optional parameter used for recurring payments or subscriptions to handle insufficient funds scenarios. Instead of rejecting the payment immediately, it defines a time window during which the customer can complete the payment manually. If the payment is not completed within this period, it will expire.

Example: 60

automatic_transaction_details object

Provides additional information on the automated transaction.

transaction_typestringrequired

Type of transaction - CIP_ONE_TIME, MIP_SCHEDULED or MIP_UNSCHEDULED

CIP_ONE_TIME for one click transactions,

MIP_SCHEDULED for subscriptions,

MIP_UNSCHEDULED for one off transactions without user input

Example: MIP_SCHEDULED

subscription_idstring

Optional identifier of the subscription associated with the transaction.

Example: SUB ID 1

descriptionstring

Optional description of the automated transaction.

Example: Monthly DexFlix subscription

InitiatePaymentToken

{
  "type": "PAYSAFECARD",
  "amount": 0.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"
  },
  "submerchant_id": "SUBM1234",
  "shop_id": "Shop_ABC",
  "payment_token": "spi_ZmBMcOQNuH3dRTeDReSZBjLIbb",
  "expiration_time_minutes": 60,
  "automatic_transaction_details": {
    "transaction_type": "MIP_SCHEDULED",
    "subscription_id": "SUB ID 1",
    "description": "Monthly DexFlix subscription"
  }
}