Kite
API ReferenceCheckout

Cancel a transfer that hasn't been paid

POST
/api/checkout/{id}/transfer/{transferId}/cancel

Path Parameters

id*string
Formatuuid
transferId*string
Formatuuid

Response Body

Response for status 200

application/json
  1. response
id*string
Formatuuid
status*string
Value in"Created""AwaitingDeposit""DepositReceived""Processing""x402Settled""Cancelled""Refunded""Failed""Settled"
payinAddress*string
Match^0x[0-9a-fA-F]{40}$
x402BlockchainHash*string|null
settlementBlockchainHash*string|null
refundBlockchainHash*string|null
expiresAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X POST 'https://testnet.usekite.site/api/checkout/497f6eca-6276-4993-bfeb-53cbbbba6f08/transfer/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel'
Example Response200
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "Created",  "payinAddress": "string",  "x402BlockchainHash": "string",  "settlementBlockchainHash": "string",  "refundBlockchainHash": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}