Add a leg to a payment

Creates a transfer that moves part of the money of a payment you pay, and links it to the payment as a leg. The transfer goes to the institution in beneficiary_entity_did on its own thread, through the same compliance checks as any transfer, with your customer as originator and the payment's merchant as beneficiary. Returns 409 Conflict when you do not pay the payment or it is settled, rejected, canceled or reverted. Reusing a ref returns the leg it created.

Required permission: create:transfer.

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

Unique identifier for the payment.

Body Params
string
required

The amount transferred, in the asset's whole units rather than its smallest unit. For example 1.5 ETH, not 1500000000000000000.

string
required

The asset being transferred, as a CAIP-19 identifier or a plain symbol such as BTC. Symbols resolve to their canonical CAIP-19 identifier.

string
required

DID of the institution the leg pays.

string
required

Your own unique reference for this leg (UUID). Reusing it makes adding the leg idempotent.

string

Your own fiat valuation of the leg, as a decimal string in USD. Required when Notabene cannot price the asset.

string

Free-text memo carried with the transfer.

string

XRPL destination tag or Stellar memo for the settlement address. Equivalent to appending :tag to settlement_address.

string

The address the funds are sent to. Accepts a bare address, a CAIP-10 identifier or a did:pkh; a bare address is interpreted on the asset's chain.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

429

Too Many Requests: more than 6,000 calls in 300 seconds. Every endpoint refuses your calls for the next 10 seconds. Send the request again with a backoff, as Rate limiting explains.

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