Checkout

GET 
/checkout/:checkoutId

Returns the data of a checkout created using /v2/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

for coins where network is included in networksWithMemo array

settleAmount stringrequired
updatedAt date-timerequired
createdAt date-timerequired
affiliateId stringrequired
successUrl stringrequired
cancelUrl stringrequired
orders array
id stringrequired

shift/order ID

deposits array
depositHash string
settleHash string

Example

{
  "id": "fdebd5b5-357a-4cfd-b60b-076ae7c62d77",
  "settleCoin": "BTC",
  "settleNetwork": "mainnet",
  "settleAddress": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
  "settleAmount": "0.001",
  "updatedAt": "2024-01-01T00:55:33.222000000Z",
  "createdAt": "2024-01-01T00:55:33.222000000Z",
  "affiliateId": "YOUR_ACCOUNT_ID",
  "successUrl": "https://yourwebshop.com/success",
  "cancelUrl": "https://yourwebshop.com/cancel",
  "orders": [
    {
      "id": "d2a473f82603e9ccfbb8",
      "deposits": [
        {
          "depositHash": "0x73b277e5df00f57a03cbe6ca318ca79e66398a2f3f9ff414966a7ec281e903c8",
          "settleHash": "055f7d293ebd4546b446da0eb920c5c427d72647ae58262e53b8a8a574544dd9"
        }
      ]
    }
  ]
}

404

Not Found

application/json

Schema

Schema

error object
message stringrequired

Example

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

Loading...