Create transfer

post

https://api.notabene.id/tx/create

Creates a new transfer. The fields required in a transfer differ depending on the jurisdiction of the originating VASP.
Additional data may be provided to the beneficiary VASP depending on their jurisdiction.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Transfers Information

transactionRef

string

Idempotency key: to prevent duplicate transactions and proactively manage disruptions arising from the idempotency key becoming mandatory in the future, it is highly recommended to populate this field with a unique identifier for the transfer

transactionAsset

required

Asset symbol (BTC,ETH)

transactionAmount

string

required

^0*[1-9][0-9]*$

Amount in base unit of the asset (satoshi, wei, etc)

transactionAssetDecimals

number

Asset decimals

customAssetPrice

Object containing custom asset price if not available in Notabene

originatorDid

string

^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryDid

string

^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryRef

string

originatorRef

string

originatorVASPdid

string

required

^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryVASPdid

string

^did:[a-zA-Z0-9]*:.*$

Beneficiary VASP did - If you do not have this data, we will try to resolve it.

beneficiaryVASPname

string

Beneficiary VASP Name - If you do not have this data, we will try to resolve it.

beneficiaryVASPwebsite

string

Beneficiary VASP Website - If the VASP does not already have one, it is required to provide it.

transactionBlockchainInfo

object

required

Information about the transaction on the blockchain

originator

object

The originator is defined in Section 1.1 as the account holder who allows the VA transfer from that account or, where there is no account, the natural or legal person that places the order with the originating VASP to perform the VA transfer.

beneficiary

object

The beneficiary is defined in Section 1.1 as the natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer.

encrypted

string

Encrypted Personal Identificable Information (obscure schema-less value)

protocol

string

enum

Allowed:

notificationEmail

string

Beneficiary VASP Notification Email

skipBeneficiaryDataValidation

boolean

Disable beneficiary data validation (opportunistic compliance)

travelRuleBehavior

boolean

Should consider beneficiary's jurisdiction in determining if a transfer is of type TRAVEL_RULE

originatorProof

object

Ownership Proof, which can be an CryptographicalProof, ScreenshotProof, SelfDeclarationProof or MicroTransferProof

beneficiaryProof

object

Ownership Proof, which can be an CryptographicalProof, ScreenshotProof, SelfDeclarationProof or MicroTransferProof

pii

object

network

string

Chainalysis network

onBehalfOfMyself

boolean

Autopopulate originator and beneficiary fields with institution's information

blockchainTransactionTimestamp

date-time

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Transfer created

400Bad Request

401Unauthorized