NOnotabene
Transactions

Cancel transfer

Cancels the transfer and sets the status to CANCELLED.

post/tx/cancel

Request

Request body

idstring uuid required

Identifier of the Transfer

vasp_didstring

Decentralized Identifier

reasonstring

Cancel reason

Example request

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "vasp_did": "did:methd:identifier"
}

Response

Transfer Cancelled

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'

Changes

No recorded changes to this operation across all 1 revision of this API.