CheckoutSessionResponse

sessionIdstringrequired

The unique identifier of the checkout session

secureCodeSecureCode (string)required

The secure code for the sessionId

createdAtstring<date-time>

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

expiresAtstring<date-time>required

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

paymentBoundAtstring<date-time>

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

statusCheckoutSessionStatus (string)

Possible values: [CREATED, SENDER_BOUND, PAYMENT_BOUND, COMPLETED, EXPIRED, CANCELLED]

brandstring

The brand of the recipient

redirectUrlstring

The url where the wallet checkout flow starts

walletCheckoutPageUrlstring

Thr url where the user is being redirected after login

merchantRefNumstring

The merchant reference number of the checkout session

amountinteger<int64>

The amount to be transferred to the recipient in minor units.

currencyCodeCurrency (string)

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR

returnUrlstringrequired

The redirect URL of the session

recipient object

customerIdCustomerId (string)required

The id of the wallet.

sender objectrequired

customerIdCustomerId (string)

The id of the wallet.

emailstring

The email address of the sender associated with the wallet account email

lineItems object[]required

Array [

descriptionstring

The name of the item

productCodestring

The product code of the item

quantityinteger

The quantity of the item

unitAmountinteger<int64>

The unit amount of the item

totalAmountinteger<int64>

The total amount of the item

]

payment object

idstringrequired

The unique identifier of the payment

slipIdstring

The unique identifier of the slip

statusCheckoutPaymentStatus (string)required

Possible values: [PREVIEW, PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED]

amountinteger<int64>required

The amount to be transferred to the recipient in minor units.

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR

availableBalanceinteger<int64>required

The available balance of the recipient account

balanceAfterUpdateinteger<int64>required

The balance of the recipient account after the transfer

createdAtstring<date-time>required

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

CheckoutSessionResponse

{
  "sessionId": "string",
  "secureCode": "string",
  "createdAt": "2021-07-15T17:54:12Z",
  "expiresAt": "2021-07-15T17:54:12Z",
  "paymentBoundAt": "2021-07-15T17:54:12Z",
  "status": "CREATED",
  "brand": "string",
  "redirectUrl": "string",
  "walletCheckoutPageUrl": "string",
  "merchantRefNum": "string",
  "amount": 0,
  "currencyCode": "EUR",
  "returnUrl": "string",
  "recipient": {
    "customerId": "string"
  },
  "sender": {
    "customerId": "string",
    "email": "string"
  },
  "lineItems": [
    {
      "description": "string",
      "productCode": "string",
      "quantity": 0,
      "unitAmount": 0,
      "totalAmount": 0
    }
  ],
  "payment": {
    "id": "string",
    "slipId": "string",
    "status": "PREVIEW",
    "amount": 0,
    "currencyCode": "EUR",
    "availableBalance": 0,
    "balanceAfterUpdate": 0,
    "createdAt": "2021-07-15T17:54:12Z"
  }
}