Skip to main content
POST
curl

Authorizations

x-api-key
string
header
required

Body

application/json
chain
string
required

Chain the deposit settled on, e.g. "ethereum".

txid
string
required

On-chain transaction hash. Deduped together with wallet_address.

wallet_address
string
required

The destination wallet you received the deposit on.

amount
string
required

Deposit amount as a decimal string.

currency
string
required

Deposit asset, e.g. "USDC".

originator_data
object

IVMS-101 originator payload from the sending VASP, if known.

beneficiary_data
object

IVMS-101 beneficiary payload (your customer).

originating_vasp
object

Optional description of the sending VASP.

Response

An existing unclaimed deposit was reused (created is false).

transaction_id
string<uuid>

Didit transaction UUID for the inbound deposit.

txn_id
string

Didit-generated txn_id for the sunrise transaction.

created
boolean

true when a new transaction was minted (HTTP 201); false when an existing unclaimed deposit was reused (HTTP 200).

travel_rule
object

Full transfer object returned by the ownership-confirmation and finish/cancel endpoints. originator_data/beneficiary_data are omitted while PII is masked (see description).