Report the result of the transaction(Transaction ID) after the transfer of the asset has been executed.
A VASP who transfers the virtual asset shall send the transfer result (Transaction ID) of the corresponding asset to the VASP to whom the asset is transferred immediately after transferring an asset, and use this API.
Tx ID or tx hash must always use blockchain Node Output data.
Adding '0x' in front of a tx hash can lead to a mismatch in the tx hash.
Please be cautious not to include '0x' which is not part of the Node Output.
Verify Result
- This API works in synchronous manner that immediately returns a response from the counterparty, allowing you to determine whether the txid delivery was successful or failed.
- If you receive a response other than 'normal', it is recommended to implement a retry logic with an appropriate number of attempts.
- If a normal response is still not received after all retry attempts have been exhausted, further investigation is required. In this case, please inform the CodeVASP team.
Smart Contract Transactions
- Transactions executed via smart contracts may be rejected for deposit depending on the beneficiary VASP’s policy. Therefore, always check the counterparty VASP’s policy first.
- Multi-signature transactions are a typical example.
- To process these types of transactions in compliance with the protocol, one possible approach is to route the transfer through a hot wallet before sending it out.
Path Parameter
| Name | Required | Type | Description |
|---|---|---|---|
| BeneficiaryVaspEntityId | Required | string | This shall be entered as the EntityID of the VASP who owns the address to which the asset is transferred. |
Request
| Name | Required | Type |
|---|---|---|
| transferId | Required | string |
| txid | Required | string |
| vout | Optional | string |
transferId: This is UUID assigned to the an asset transfer authorization request. It updates the asset transfer result to the corresponding transaction.
txid: This is a transaction ID generated for virtual asset transfer. This is the information generated on each blockchain.
vout: For the utxo type coin, multiple txids can be created so that vout is required to distinguish unique txids.
{
"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.