Action Transfer
PATCH /api/v2/travelrule/transfers/{transfer_id OR reference_id}/{action}
This endpoint is used to take actions on a transfer depending on the current transfer status.
Path Parameters
transfer_id
string
A system-generated identifier unique to each transaction
Example: 0663cc41-ef29-7995-8000-2d9b414b3174
reference_id
string
A unique identifier provided by the originator when initiating the transfer.
Example: transfer20250312040414
action
string
The action to be applied. See list of supported actions below.
Transfer Status and Supported Actions
The allowed transfer actions depend on the protocol used 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 counterparty VASP. Each action taken—such as “accept,” “reject,” or “complete”—triggers a change in the transfer’s status, ensuring that the workflow reflects the real-time state of the transaction.
-
INITIATED
The transfer request is sent to the beneficiary VASP using the Create Transfer endpoint.
-
REVIEW
The transfer request is being reviewed by the beneficiary VASP.
cancel
CANCELED
The originator VASP canceled the transfer request using the Action Transfer endpoint.
reject
REJECTED
The beneficiary VASP rejected the originator VASP’s request, providing a reason and indicating whether a retry is allowed, using the Action Transfer endpoint.
accept
ACCEPTED
The beneficiary VASP accepted the transfer request, allowing the originator VASP to proceed with executing the crypto transaction using the Action Transfer endpoint.
complete
COMPLETED
The originator VASP has completed the execution of the crypto transaction using the Action Transfer endpoint.
Request Body
reject_error
string
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"
Understanding Travel Rule Transfer Statuses
The status of a Travel Rule transfer evolves as the transfer progresses through different stages. Importantly, the status can differ depending on the point of view:
Originator’s View - The sender (originator) sees the status reflecting the current action they have completed or are awaiting confirmation on. Beneficiary’s View - The recipient (beneficiary) sees a status representing what is pending on their side, such as needing to review, accept, or reject the transfer.
This dual perspective ensures that each party clearly understands their respective responsibilities at any given stage.
Sample Requests
Response
Last updated