Skip to navigation
API ReferenceFunding

Get transfer state

Retrieve the transfer state of a fund transfer by transfer ID or client-supplied ID.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Query parameters

transIdstringOptional
Transfer ID. Either transId or clientId is required. If both are passed, transId will be used.
clientIdstringOptional

Client-supplied ID. A combination of case-sensitive alphanumerics, all numbers, or all letters, up to 32 characters.

typeenumOptional

Transfer type: 0=transfer within account, 1=master-to-subaccount (by master), 2=subaccount-to-master (by master), 3=subaccount-to-master (by sub), 4=subaccount-to-subaccount. Default is 0.

Allowed values:

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional