Checkout

GET 
/checkout/:checkoutId

Returns the data of a checkout created using /checkout endpoint.

Request

Path Parameters

checkoutId stringrequired

Responses

200

OK

application/json

Schema

Schema

id stringrequired

unique checkout ID

settleCoin stringrequired
settleNetwork stringrequired
settleAddress stringrequired
settleMemo string
settleAmount stringrequired
updatedAt date-timerequired
createdAt date-timerequired
affiliateId stringrequired
successUrl stringrequired
cancelUrl stringrequired

Example

{
  "id": "32e676d3-56c2-4c06-a0cd-551a9d3db18b",
  "settleCoin": "XRP",
  "settleNetwork": "ripple",
  "settleAddress": "rsTAYkk7VQfBdD5btt2WzXYphER6F2BTuN",
  "settleMemo": "109",
  "settleAmount": "15",
  "updatedAt": "2024-09-26T01:52:56.885000000Z",
  "createdAt": "2024-09-26T01:52:56.885000000Z",
  "affiliateId": "YQMi62XMb"
  "successUrl": "https://example.com/success",
  "cancelUrl": "https://example.com/cancel"
}

404

Not Found

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
      "message": "Checkout not found"
  }
}

Loading...