Skip to main content
GET
Get crypto transfer by reference
Fetches the status of a crypto transfer by reference.

Authorizations

x-api-key
string
header
required

Requires authentication via API key and HMAC signature.

  • x-api-key: Your API key generated from your Onboard Business dashboard.
  • x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 seconds
  • x-signature: SHA256 HMAC HEX signature calculated over t={x-timestamp}&{requestBody} using your API Secret.

Path Parameters

transferReference
string
required

The transfer unique ID

Response

Crypto Transfer fetched successfully

id
string
required

Unique transaction ID

Example:

"txn_123456"

reference
string
required

Unique transaction reference.

Example:

"REF123456"

type
enum<string>
required
Available options:
DEPOSIT,
WITHDRAWAL,
TRANSFER
amount
number
required

Transaction amount, negative for debits, positive for credits

Example:

100

currency
string
required

Transaction currency

Example:

"USD"

status
enum<string>
required

Status of the transaction, indicating its current state in the processing lifecycle.

  • PENDING: The transaction has been created but not yet processed.
  • IN_PROGRESS: The transaction is currently being processed.
  • FAILED: The transaction processing has failed.
  • SUCCESS: The transaction has been successfully processed.
Available options:
PENDING,
IN_PROGRESS,
FAILED,
SUCCESS
createdDate
string<date-time>
required

Transaction creation date

categoryTag
string

Category tag for the transaction

Example:

"crypto-withdrawal"

notes
string

Transaction description

Example:

"Conversion from USDC to IDR"

accountId
string<uuid>

Associated account ID

feeAmount
number

Fee amount associated with the transaction

Example:

1

feeInclusive
boolean

Indicates if the fee is inclusive in the transaction amount

subAccountId
string<uuid>

Associated sub-account ID, if applicable

blockchainInfo
object

Blockchain transaction data, present on Crypto-backed transactions.