Skip to main content
GET
Get specific cash payment
Fetches a single cash payout 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

reference
string
required

Response

cash payment details

Details of a cash payment transaction.

id
string<uuid>
required
reference
string
required

Reference for the cash payment transaction at initiation.

currency
string
required

Currency in which the account was debited.

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
payoutCurrency
string
required

Currency in which the beneficiary will be paid out.

Example:

"NGN"

amount
number
required

Amount transferred.

Example:

100

rate
number
required

Exchange rate applied for this transfer.

Example:

1450.75

payoutAmount
number
required

Amount paid out to the beneficiary in payout currency.

Example:

145075

recipient
object
required

Basic information about a beneficiary as at the time of transaction.

createdDate
string<date-time>
required
accountTransactionId
string

Identifier of the transaction on the account.

providerReference
string

Reference provided by the cash payment provider.

Example:

"PROV123456"