Initiator API 4 - End Travel Rule
Where should I integrate?
To Use
This API is used to record and update the status when the Originator cancels a Travel Rule request. It allows the Originator to notify the system about the cancellation along with a reason.
API Endpoint
POST /api/verify/v2/end
Request Body
{
"requestId": "original request id",
"reasonType": "ADDRESS_BOOK_VERIFY_PURPOSE",
"reason": "put some reason here"
}
- requestId: The original Travel Rule request ID that is being cancelled.
- reasonType: The type/category of the cancellation reason. For example, "ADDRESS_BOOK_VERIFY_PURPOSE". For other cases please check the table below.
- reason: A descriptive reason explaining why the Travel Rule was cancelled.
Reason Type Table:
*Please use the Code as the variable in the GTR API.
| Code | Description |
|---|---|
| UNKNOWN | unknown |
| INTERRUPTED | interrupted transaction |
| ADDRESS_BOOK_VERIFY | For address book whitelisting purposes |
| WITHDRAW_PROCESS_DNC | Withdrawal process disconnected, possibly due to app or other interruption |
| UNABLE_PROCESS | Unable to process, please contact VASP for more information |
| SYSTEM_ISSUE | Internal Error |
| REJECTED | Reject transfer without reason |
| CANCELLED | Cancelled by user |
| TRANSFER_REJECTED | Reject transfer without reason |