API Reference
GuidesReleasesPostmanRecipesAPI Reference

Create a new transfer

post
https://api.eu1.notabene.id/entities//tx

Creates a new transfer from the specified entity to another entity. This is the entry point for initiating a new transfer in the system.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^did:([a-z0-9]+):((?:(?:[a-zA-Z0-9._-]|(?:%[0-9a-fA-F]{2}))*:)*(?:[a-zA-Z0-9._-]|(?:%[0-9a-fA-F]{2}))+)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(/[^#?]*)?([?][^#]*)?(#.*)?$

The DID of the entity

Body Params
originator
object
required
beneficiary
object
required
string
required
(^[A-Z0-9-]{2,20}$)|(^[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,64}\/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}(\/[-.%a-zA-Z0-9]{1,78})?$)|(^[A-Za-z0-9]{10}$)
string
required
^\d+(\.\d+)?$
agents
array of objects
required
length ≥ 1
agents*
string
required
length between 2 and 255
enum
Defaults to Unknown
Allowed:
string
length between 2 and 255
policies
array of objects
length ≥ 1
policies
enum
required
Allowed:
string
length between 1 and 28
^[ -~]+$

Optional memo tag or destination tag for address agents (SourceAddress, SettlementAddress)

string

Asset selected by this agent (CAIP-19 or ISO currency identifier)

string

Settlement address selected by this agent

string
required
length between 1 and 64
^[a-zA-Z0-9_-]{1,64}$
string

Transaction hash in CAIP-220 format (e.g., eip155:1:tx/0x...). Raw hashes are automatically normalized to CAIP-220 when chain context is available from the asset.

object | null
string
length between 1 and 28
^[ -~]+$
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?