Skip to content

Get On-Chain Transfer
Experimental

Request

Gets a single on-chain transfer by ID, incoming or outgoing. For an outgoing transfer, transaction_hash is null until the USDC has been sent on-chain. An incoming transfer has no counterparty_id; counterparty_wallet_address is the wallet it was sent from, or null if it was not recorded.

Security
HTTPBearer
Path
transfer_idstring, (uuid)(Transfer Id)required
Headers
x-jiko-idempotencystring, (uuid)(X-Jiko-Idempotency)required

A new UUID that you generate for each request, reads included. It is part of the request signature and prevents replay of a request. A value that was already sent in the last hour is rejected with 409 jiko.errors.DuplicateRequestError, even if the first request failed. When you retry a request, generate a new value and sign the request again.

x-jiko-signaturestring(X-Jiko-Signature)required

Base64-encoded HMAC-SHA256 hash of x-jiko-idempotency + request pathname + body, keyed with your shared secret. See Authentication for the full algorithm and a code sample.

curl -i -X GET \
  'https://your-partner-name.sandbox-api.jikoservices.com/api/v1/transfers/on-chain/{transfer_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

Responses

Successful Response

Bodyapplication/json
idstring, (uuid)(Id)required
statusstring(Status)required
Enum:"PROCESSING""COMPLETED""REJECTED""FAILED"
pocket_idstring, (uuid)(Pocket Id)required
counterparty_idstring or null(Counterparty Id)required
Any of:
string (uuid)
amountobject(Amount)required
time_createdstring, (date-time)(Time Created)required
descriptionstring or null(Description)
Any of:
string
transaction_hashstring or null(Transaction Hash)
Any of:
string
directionstring(Direction)required
Enum:"INCOMING""OUTGOING"
counterparty_wallet_addressstring or null(Counterparty Wallet Address)
Any of:
string
object_typestring(Object Type)read-onlyrequired
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "PROCESSING", "pocket_id": "b88a2887-96aa-45d6-8252-451370ee2257", "counterparty_id": "fd38dae9-b300-4017-a630-101c4279eafd", "amount": { "value": 0, "currency": "string", "formatted": "" }, "time_created": "2019-08-24T14:15:22Z", "description": "string", "transaction_hash": "string", "direction": "INCOMING", "counterparty_wallet_address": "string", "object_type": "string" }