Report Transfer Result (TX Hash)

Apply the transferred asset transfer result (Transaction ID) to the asset transfer details.

📘

POST

/v1/beneficiary/transfer/txid

• This page explains how to respond to 'Report transfer Result(TX Hash)' API.
• In this step, the receiving VASP should:
  • detect the transaction on-chain
  • receive the txid from the originating VASP and return an appropriate response
  • save the txid
  • map the travel rule data(trasnfer id) with the txid
• The typical process is approval to 'Asset Transfer Authorization' -> on-chain detection -> txid receipt. However, depending on each VASP’s node operation method and circumstances, the order of on-chain detection and txid receipt may vary.
• Therefore, be aware that you may receive a txid before the on-chain transaction is detected.
• In such cases, it is recommended to first return a normal response to the 'Report Transfer Result (TX Hash)' request, then confirm the on-chain data and update the customer’s asset accordingly.
• This entire process assumes the integrity of the protocol and trusts that the counterparty VASP will not transmit an invalid txid.

API action specification

1. Find asset transfer information with 'transferId'.
2. Update the 'txid' value of the asset transfer information found, and change the asset transfer status to confirmed.
3. If there already exists the 'txid' related to the 'transferId' provided, then beneficiary VASP should return normal when the both 'txid's are identical, otherwise returns an error.

📘

Until version 1.6, the received Transaction ID was provided at a stage where the blockchain transaction could not fail, but now it can fail. In such cases, the VASP transferring the assets will call the Asset Transfer Termination API again.

Request

Name	Required	Type	Description
transferId	Required	string	This is UUID assigned to an asset transfer authorization request. It updates the asset transfer result to the corresponding transaction.
txid	Required	string	This is a transaction ID generated from virtual asset transfer. This is the information generated on each blockchain.
vout	Optional	string	For the utxo type coin, multiple txids can be created so that vout is required to distinguish unique txids.

Sample Request

{
  "transferId": "b09c8d00-8da9-11ec-b909-0242ac120002",
  "txid": "311BFF73D9B7969CCF1042186180159C724FAB59013A7A034A93E5FB9D6BAFE6",
  "vout": ""
}

Response

Name	Required	Type
transferId	Required	string
result	Required	string
reasonType	Optional	string

transferId: This is an ID to distinguish asset transfer transactions in all APIs

---

result: This is the result of receiving originating information.

-normal: normal processing

-error: If status change is not possible

---

reasonType: If the result value is error, a value which identifies the detailed reason.

-TXID_ALREADY_EXISTS: You are trying to store a different TXID for an asset transfer that already has a TXID stored. Once a TXID is created, it may fail, but it cannot be changed.

-TRANSFER_ALREADY_FAILED: You cannot send a TXID if the blockchain transaction status of corresponding to the TransferId, already failed.

-UNKNOWN_TRANSFER_ID: TransferID cannot be found.

-UNKNOWN: Unkown error.

Sample Response

{
  "transferId": "b09c8d00-8da9-11ec-b909-0242ac120002",
  "result": "normal",
  "reasonType": "TXID_ALREADY_EXISTS"
}