Get or allocate reference code for a remittance destination

Returns the unique code that an inbound remittance quotes so it can be matched to its destination, allocating it on the first call. A destination keeps the same code for its whole lifetime, so the call is idempotent: a repeat request returns the existing code with created: false, and reading a code is just a call that comes back with created: false.

The destination is either a Bakkt account or a remittance beneficiary — send exactly one of account_id or beneficiary_id. Both must belong to the authenticated client.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

Account the remittance is paid into

uuid

Remittance beneficiary the payment is delivered to

Headers
string
length ≤ 255

Optional. Unique opaque key per logical write (e.g. UUID v4). Only applies to POST/PUT on routes that support it. Max 255 characters. Scoped to the authenticated principal. Omit for legacy behavior with no idempotency.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json