Topup schema

Property Type Description

id

string

Unique identifier for the topup request.

amount

number double

Amount to add to your organization's balance, denominated in currency_code.

currency_code

string

Currency of the topup amount. Always matches the organization's currency.

processing_fee

number double

Amount of the processing fee for the topup (typically reserved for credit card topups).

funding_source_id

string

ID of the funding_source object used for this topup.

status

string

Status of the topup

Status	Description
`created`	The topup is processing (and may be under review).
`partially_credited`	Some funds have been credited to the balance. The remainder will be credited by `expected_settlement_at`.
`fully_credited`	All funds have been added to the balance.
`reversed`	The topup was credited, but then reversed due to a chargeback or ACH return.
`rejected`	The topup was rejected by an admin.

created_at

string date-time

Timestamp indicating when the topup object was created (when the request was made).

fully_credited_at

string date-time

Timestamp indicating when the topup amount was fully credited to the balance.

rejected_at

string date-time

Timestamp indicating when the topup was rejected.

reversed_at

string date-time

Timestamp indicating when the topup was reversed.

reversed_reason

string

A sentence explaining why the topup was reversed.

idempotency_key

string

Idempotency key to prevent duplicate requests.

instant_credit_amount

number double

Amount credited to the balance immediately. Equals amount for non-ACH topups or ACH debits fully within instant funding limits. Can be 0 if nothing was credited instantly.

settled_amount

number double

Amount that will be available once the settlement period elapses. 0 if nothing is settling.

expected_settlement_at

string date

Timestamp indicating when the pending amount will be credited to the balance. Null if the topup was fully credited immediately.