Sign in

v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Transactions

Create transfer

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.

post/tx/create

Request body

transactionRefstring

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

transactionAmountstring required

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

transactionAssetDecimalsnumber

Asset decimals

originatorDidstring

Decentralized Identifier

beneficiaryDidstring

Decentralized Identifier

beneficiaryRefstring
originatorRefstring
originatorVASPdidstring required

Decentralized Identifier

beneficiaryVASPdidstring

Decentralized Identifier

beneficiaryVASPnamestring

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

beneficiaryVASPwebsitestring

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

encryptedstring

Encrypted Personal Identificable Information (obscure schema-less value)

protocol'TRLight' | 'TRP' | 'OpenVASP'
notificationEmailstring

Beneficiary VASP Notification Email

skipBeneficiaryDataValidationboolean

Disable beneficiary data validation (opportunistic compliance)

travelRuleBehaviorboolean

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

networkstring

Chainalysis network

onBehalfOfMyselfboolean

Autopopulate originator and beneficiary fields with institution's information

blockchainTransactionTimestampstring date-time

Response

Transfer created

idstring uuid required

Identifier of the Transfer

status'SAVED' | 'MISSING_BENEFICIARY_DATA' | 'NEW' | 'WAITING_FOR_INFORMATION' | 'SENT' | 'REJECTED' | 'DECLINED' | 'ACK' | 'CANCELLED' | 'INCOMPLETE' | 'ACCEPTED' | 'NOT_READY'

Status of the Transfer

  • SAVED Transfer stored.
  • MISSING_BENEFICIARY_DATA TravelRule: Transfer Information is missing beneficiary data.
  • NEW TravelRule: Transfer Information was created, but not sent yet.
  • WAITING_FOR_INFORMATION TravelRule: Transfer Information is waiting for information to send.
  • SENT TravelRule: Transfer Information was sent (TRLight/TRP)
  • REJECTED TravelRule: Transfer rejected (TRP/Sygna)
  • DECLINED TravelRule: Transfer declined (TRP/Sygna)
  • ACK TravelRule: Destination blockchain address belongs to beneficiary confirmed.
  • CANCELLED Transfer cancelled.
  • INCOMPLETE Transfer created only with Blockchain Data (called by Beneficiary).
  • ACCEPTED Transfer accepted.
  • NOT_READY Transfer not ready.
transactionType'BELOW_THRESHOLD' | 'NON_CUSTODIAL' | 'TRAVELRULE' | 'UNKNOWN' required

Type of the Transfer

  • BELOW_THRESHOLD Transfer is below all threshold.
  • NON_CUSTODIAL Transfer is on a customer owned wallet. Proof required.
  • TRAVELRULE Transfer is between VASPs. TravelRule transfer created.
  • UNKNOWN Transfer with any missing information.
transactionAssetstring required

Asset symbol (BTC,ETH)

transactionAmountstring required

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

chargedQuantitynumber required

Charged Quantity

originatorDidstring

Decentralized Identifier

beneficiaryDidstring required

Decentralized Identifier

originatorVASPdidstring

Decentralized Identifier

beneficiaryVASPdidstring

Decentralized Identifier

ivms101Encryptedstring

Encrypted IVMS101 data

protocol'TRLight' | 'TRP' | 'OpenVASP'