Kite
API ReferenceTransfers

Get a transfer

GET
/api/transfers/{id}

Authorization

headerx-kite-signature<token>

Base64url Ed25519 signature of timestamp nonce METHOD path?query sha256(body), sent with x-kite-api-key-id, x-kite-timestamp and x-kite-nonce

Path Parameters

id*string
Formatuuid

Response Body

Response for status 200

application/json
  1. response
id*string
Formatuuid
appId*string
Formatuuid
quoteId*string
Formatuuid
settlementRecipient*string
Match^0x[0-9a-fA-F]{40}$
minAmountOut*string
Match^[0-9]+$
Lengthlength <= 78
refundAddress*string
Match^0x[0-9a-fA-F]{40}$
payinAddress*string
Match^0x[0-9a-fA-F]{40}$
kiteTransferInput*
status*string
Value in"Created""AwaitingDeposit""DepositReceived""Processing""x402Settled""Cancelled""Refunded""Failed""Settled"
settlementBlockchainHash*string|null
refundBlockchainHash*string|null
x402Payer*string|null
x402AuthorizationNonce*string|null
x402AuthorizationHash*string|null
x402SettlementCallId*string|null
x402BlockchainHash*string|null
x402LeaseExpiresAt*|
Formatdate-time
x402SettledAt*|
Formatdate-time
x402Offer*boolean
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
timeline*array<>
quote*
Example Request
curl -X GET 'https://testnet.usekite.site/api/transfers/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response200
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "appId": "28c365d5-df94-4a54-8217-3ce51d068868",  "quoteId": "826e5192-f8c6-4e24-aab3-3910e46c52b7",  "settlementRecipient": "string",  "minAmountOut": "string",  "refundAddress": "string",  "payinAddress": "string",  "kiteTransferInput": {    "id": "string",    "payInTokenAddress": "string",    "amountIn": "string",    "settlementTokenAddress": "string",    "settlementRecipient": "string",    "minAmountOut": "string",    "fees": [      {        "id": "string",        "recipient": "string",        "amount": "string"      }    ],    "refundAddress": "string",    "expiresAt": "string",    "routerAddress": "string",    "poolFeeTier": 0  },  "status": "Created",  "settlementBlockchainHash": "string",  "refundBlockchainHash": "string",  "x402Payer": "string",  "x402AuthorizationNonce": "string",  "x402AuthorizationHash": "string",  "x402SettlementCallId": "string",  "x402BlockchainHash": "string",  "x402LeaseExpiresAt": "2019-08-24T14:15:22Z",  "x402SettledAt": "2019-08-24T14:15:22Z",  "x402Offer": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "timeline": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "transferId": "e240f72a-b0bc-4f57-ab86-5b78f1d8ea9b",      "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",      "description": "string",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "quote": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "appId": "28c365d5-df94-4a54-8217-3ce51d068868",    "chainId": "9e7fb22a-9e5b-420e-8fd7-e3454fcfd5fd",    "paymentLinkId": "65854dcb-f544-4848-b04d-cccad43b01a8",    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",    "sourceTokenId": "dfe833b7-a2d6-4d29-ad49-5503dba9d33b",    "targetTokenId": "9e1bf350-d170-4c02-b746-e67c80e89e31",    "sourceUsdAmount": "string",    "sourceAmount": "string",    "targetAmount": "string",    "targetUsdAmount": "string",    "rate": "string",    "uniswapPoolFeeTier": 0,    "reference": "string",    "meta": {},    "expiresAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "customer": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "appId": "28c365d5-df94-4a54-8217-3ce51d068868",      "externalId": "string",      "name": "string",      "traits": {},      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "paymentLink": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "appId": "28c365d5-df94-4a54-8217-3ce51d068868",      "title": "string",      "currency": "string",      "amount": "string",      "usage": "OneTime",      "lineItems": [        {          "image": "string",          "name": "string",          "price": "string",          "quantity": 0        }      ],      "reference": "string",      "meta": {},      "returnUrl": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "chain": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "isActive": true,      "caip2Id": "string",      "deletedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "sourceToken": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "chainId": "9e7fb22a-9e5b-420e-8fd7-e3454fcfd5fd",      "address": "string",      "symbol": "string",      "decimals": 0,      "name": "string",      "version": "string",      "icon": "string",      "supportsEIP3009": true,      "listed": true,      "deletedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "targetToken": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "chainId": "9e7fb22a-9e5b-420e-8fd7-e3454fcfd5fd",      "address": "string",      "symbol": "string",      "decimals": 0,      "name": "string",      "version": "string",      "icon": "string",      "supportsEIP3009": true,      "listed": true,      "deletedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "fees": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "quoteId": "826e5192-f8c6-4e24-aab3-3910e46c52b7",        "feeId": "9ed713df-fd25-4df4-998a-8235f4f7a0b3",        "label": "string",        "amount": "string",        "feeAddress": "string",        "blockchainHash": "string",        "createdAt": "2019-08-24T14:15:22Z"      }    ]  }}

Create transfer for a quote POST

Previous Page

List transfers GET

Next Page