Flow

Authorize payout by selecting asset and optional settlement address

Authorizes a payout by confirming the asset to be used and, optionally, a settlement address. Requirements depend on whether the entity is initiator or responder in the workflow.

post/entities/{entityDID}/flow/payouts/{payoutId}/settlement_asset

Request

Base URL
https://api.eu1.notabene.id
Auth
HTTP bearer
TypeScript
https://skmtc.dev/notabene/apis/notabene-api/docs/entities/:entityDID/flow/payouts/:payoutId/settlement_asset/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

payoutIdstring uuid required

Unique identifier for the payout transaction

Request body

assetstring required

Selected asset (CAIP-19)

settlementAddressstring

Optional settlement address (CAIP-10 or payto://)

Response

Authorization accepted

messagestring

transferIdstring

assetobject