InitiatePaymentTokenResponse

The response to an automated payment using the obtained payment_token

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.

Example: SUCCESS

typestringrequired

Payment method type

Example: PAYSAFECARD

amountnumber<float>required

Payment amount

Example: 0.01

notification_urlstring<uri>

URL where payment notifications are sent

Example: https://paymentnotification.site/example

customer objectrequired

Customer associated with the payment

idstringrequired

Merchant customer identifier

Example: TestUser123

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 customer cancels the payment

Example: https://www.guinbox.com/notes/FP8gU99Wj7u

submerchant_idstring

Identifier of the submerchant

Example: SUBM1234

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

InitiatePaymentTokenResponse

{
  "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"
  },
  "redirect": {
    "success_url": "https://www.guinbox.com/notes/uC5lKyzh74x",
    "failure_url": "https://www.guinbox.com/notes/FP8gU99Wj7u"
  },
  "submerchant_id": "SUBM1234",
  "automatic_transaction_details": {
    "transaction_type": "MIP_SCHEDULED"
  }
}