Sign in

v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Transactions

Update transfer

Update a transfer with the passed parameters.

post/tx/update

Request body

idstring uuid required

Identifier of the Transfer

notificationEmailstring email

Beneficiary VASP Notification Email

txHashstring

Transaction txHash

destinationstring

Destination Blockchain Address

originstring

Origin Blockchain Address

beneficiaryDidstring

Decentralized Identifier

beneficiaryVASPdidstring

Decentralized Identifier

originatorVASPdidstring

Decentralized Identifier

beneficiaryVASPnamestring

Beneficiary VASP Name

originatorDidstring

Decentralized Identifier

beneficiaryRefstring
originatorRefstring
protocol'TRLight' | 'TRP' | 'OpenVASP'
skipBeneficiaryDataValidationboolean

Disable beneficiary data validation (opportunistic compliance)

isNonCustodialboolean

Is a Non Custodial Transfer

onBehalfOfMyselfboolean

Autopopulate originator and beneficiary fields with institution's information

blockchainTransactionTimestampstring date-time

Response

Transfer Updated

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'