Action Transfer

PATCH /api/v2/travelrule/transfers/{transfer_id}/{action}

This endpoint is used to change the status of a transfer.

Path Parameters

Name	Type	Description	Required
transfer_id	string	The ID of the transfer. Example: 0663cc41-ef29-7995-8000-2d9b414b3174	True
action	string	The action to be applied. See list of supported actions below.	True

Request Body

Name	Type	Description	Required
retry	boolean	Indicates if transfer request should be updated for resending.	True if action is "reject"
reject_error	integer	The rejection error code of the transfer request. See below for the list of error codes.	True if action is "reject"
message	string	Additional information on why transfer request is rejected.	True if action is "reject"
transaction_hash	string	The blockchain transaction hash of the completed crypto transaction.	True if action is "complete"

Transfer Status

Transfer Status	Description
INITIATED	The transfer request is being sent to the beneficiary VASP.
CANCELED	The originator VASP canceled the transfer request.
REVIEW	The transfer request is being reviewed by the beneficiary VASP.
REPAIR	The originator VASP updates the transfer request based on the rejection reason.
REJECTED	The beneficiary VASP rejected the request of the originator VASP, with the reason and flag if a retry is requested.
ACCEPTED	The beneficiary VASP accepted the transfer request, and the originator VASP can now proceed with executing the crypto transaction
COMPLETED	The originator VASP has completed executing the crypto transaction.

Transfer Action Scenarios

The allowed transfer actions depend on the protocol and whether the transfer is outgoing or incoming. An outgoing transfer is initiated by the VASP to send a transfer request to a counterparty, while an incoming transfer is a transfer request received by the VASP from a counterparty.

Protocol	Outgoing Transfer	Incoming Transfer
flow	cancel, repair, complete	accept, reject
trisa	repair, complete	accept, reject
trp	complete	accept, reject

Reject Error Codes

ID	Code	Description
0	REJECTED	Default rejection reason.
1	UNKNOWN_WALLET_ADDRESS	VASP doesn't control the beneficiary wallet address.
2	UNKNOWN_ORIGINATOR	VASP doesn't have KYC information for the beneficiary wallet address.
3	UNKNOWN_BENEFICIARY	The originator account can't be identified.
4	UNSUPPORTED_CURRENCY	The beneficiary account can't be identified.
5	EXCEEDED_TRADING_VOLUME	VASP can't receive more transaction inflows.
6	COMPLIANCE_CHECK_FAIL	VASP internal compliance check has failed.
7	NO_COMPLIANCE	VASP not able to implement travel rule compliance.
8	HIGH_RISK	VASP unwilling to proceed with the transaction after risk assessment.
9	OUT_OF_NETWORK	Wallet address or transaction is not available on the specified blockchain network.
10	BAD_REQUEST
11	UNPARSEABLE_IDENTITY	Unable to parse identity record.
12	PRIVATE_INFO_WRONG_FORMAT
13	UNPARSEABLE_TRANSACTION	Unable to parse transaction data record.
14	MISSING_FIELDS	There are missing required fields in the transaction data.
15	INCOMPLETE_IDENTITY	The identity record is not complete enough for compliance purposes.
16	VALIDATION_ERROR	There was an error validating a field in the transaction data.
17	COMPLIANCE_PERIOD_EXCEEDED	The review period has exceeded the required compliance timeline.
18	CANCELED	The transfer request was canceled.

Response

200

{
  "status": "success",
  "data": {
    "transfer_id": "0663cc41-ef29-7995-8000-2d9b414b3174",
    "amount": 1,
    "amount_usd": 101234.00,
    "dti": "4H95J0R2X",
    "dti_name_short": [
      "BTC",
      "XBT"
    ],
    "dti_name_long": "Bitcoin",
    "protocol": "trp",
    "beneficiary_vasp_id": "ABCXYZ",
    "originator_address": "14qViLJfdGaP4EeHnDyJbEGQysnCpwk3gd",
    "beneficiary_address": "1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX",
    "originator_account_reference_id": "account5678",
    "beneficiary_account_reference_id": "account1234",
    "transaction_hash": "80003fee6bcbb2726b4d6466d690fce6caaa03771aada747eb0651637514b893",
    "transfer_status": "ACCEPTED"
  }
}