Skip to main content
POST
curl

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Body

application/json
beneficiary_wallet_address
string
required

The destination wallet address. The Didit Test VASP sends to it, matched against your wallet address book on the chain of the asset. A wallet with no matching entry is accepted and the inbound transaction is booked ON_HOLD.

scenario
enum<string>
default:accept

What the Didit Test VASP declares the beneficiary to be. accept declares the holder's own name; name_mismatch declares a name no holder agrees with. The decision itself is always yours.

Available options:
accept,
name_mismatch
chain
string
default:ETH

Chain of the asset.

amount
string
default:1

Amount as a decimal string.

currency
string
default:ETH

Asset code.

reference
string

Optional idempotency key. A repeat with the same value returns the transfer the first call booked.

Response

The inbound transfer was booked and decided. A repeat with the same reference returns the same body.

transaction_id
string<uuid>

Didit transaction UUID of the inbound transfer.

txn_id
string

Didit-generated txn_id.

scenario
string

The scenario that ran.

travel_rule_status
string

The status your application's own decision resolved to.

detail
string

Why the transfer resolved to that status.

test_vasp
boolean

Always true: the sender was the Didit Test VASP.

travel_rule
object

Full transfer object returned by the ownership-confirmation and finish/cancel endpoints. While an inbound transfer's wallet ownership is unconfirmed, the counterparty's originator_data and beneficiary_data come back masked (the first letter of each word is kept; the wallet, chain and VASP routing stay readable) and data_masked is true.