Skip to main content

CheckoutSessionUpdate

idstringrequired

The unique identifier of the checkout session.

statusCheckoutSessionStatus (string)required

Possible values: [CANCELLED, COMPLETED, EXPIRED]

merchantRefNumstring

The merchant reference number of the checkout session.

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
receiver objectrequired
customerIdstringrequired

The wallet customer identifier of the receiver.

boundSender object
customerIdstringrequired

The wallet customer identifier of the bound sender.

senderBoundAtstring<date-time>

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
completedAtstring<date-time>

Represents RFC 3339, section 5.6 date-time.

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

Payment details produced by Wallet-Checkout for webhook events.

idstringrequired

The unique identifier of the payment.

statusCheckoutPaymentStatus (string)required

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

slipIdstring

The transaction slip identifier for completed or failed payments.

failureReasonstring

The failure reason for failed payments.

cancelledBystring

Indicates that the payment was cancelled.

Possible values: [merchant, system, user]

cancelledAtstring<date-time>

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
CheckoutSessionUpdate
{
  "id": "string",
  "status": "CANCELLED",
  "merchantRefNum": "string",
  "amount": 0,
  "currencyCode": "EUR",
  "receiver": {
    "customerId": "string"
  },
  "boundSender": {
    "customerId": "string"
  },
  "senderBoundAt": "2021-07-15T17:54:12Z",
  "paymentBoundAt": "2021-07-15T17:54:12Z",
  "completedAt": "2021-07-15T17:54:12Z",
  "payment": {
    "id": "string",
    "status": "PREVIEW",
    "slipId": "string",
    "failureReason": "string",
    "cancelledBy": "merchant",
    "cancelledAt": "2021-07-15T17:54:12Z"
  }
}