Errors Handling & Retry
In the Travel Rule system we have two error types:
- HTTP/API Errors: Errors when requesting GTR
- Travel Rule Errors: Business exceptions in Travel Rule or the errors between VASPs
The following are descriptions and handling methods for error types:
System Errors
| Error Name | HTTP Status Code | Verify Status Code | Solving method |
|---|---|---|---|
| No Login Session | 401 | 100021 | Trigger Login Again |
| Session Expired | 401 | 100014 | Trigger Login Again |
| No Auth | 401 | 100020 | Trigger Login Again |
| Limitation Exceeded | 402 | 100003 | Please go to GTR website and process with new subscription |
| GTR Server Fail | 500 | 100006 | Retry every 30sec, *Please contact the GTR team |
| Client Bad Parameters | 400 | 100004 | Please double check your parameters |
| Client Invalid Parameters | 400 | 100023 | Please double check your parameters |
| Request ID Duplicated | 400 | 100005 | Please swap your ID generator, it seems possible to cause conflict |
| VASP Public Key Not Found | 400 | 100016 | Please fetch VASP List to get the correct VASP public key |
| Business Fail (Common) | 200 | 100001 | The business error, please check the error message. |
Travel Rule Errors
| Error Name | HTTP Status Code | Verify Status Code | Scenario | Solving method |
|---|---|---|---|---|
| Address not found | 200 | 200001 | The address cannot be found, or multiple sets of matches are found for one address. | Let customers double-check the wallet address, network, ticker, tag, or verify the wallet address type is not a hot wallet. |
| PII Decrypt Fail | 200 | 200002 | Exception when algorithm cannot decrypt ciphertext. | Please check if your encryption key or encryption method is the same as spec. |
| PII Verify Fail (Common Fail) | 200 | 200003 | Verification does not meet the required PII compliance requirements for receiving VASP and contains mismatched or missing PII information. | PII information verification failed due to a mismatch or related reasons. *Check the verified fields and contact the VASP, or ask the customer to double-check the KYC information between the two systems. |
| Initiator Server Fail | 500 | 100007 | Initiator Server error, please check the error message. | Retry every 30sec *Please contact the GTR team. |
| Receiver Server Fail | 500 | 100008 | Receiver Server Error, please check the error message. | Retry every 30sec *Please contact the GTR team. |
| GTR Server Fail | 500 | 100006 | GTR Server Error, Please check the error message. | Retry every 30sec *Please contact the GTR team. |
| Business Fail (Common) | 200 | 100001 | Common failed, please check the error message. | *Please contact the GTR team. |
| TX ID Not found | 200 | 200007 | TX ID not found | Let the customer double-check the TX ID or verify the network beneficiary address is correct. |
| Wrong invoke procedure | 200 | 100027 | Wrong invoke procedure | Wrong invoke procedure, please follow the documentation process flow to fix it. |
| User NO KYC Fail | 200 | 200008 | Only TRSP clients may return this error, GTR users should directly use 200003. The user does not have KYC data, please let the user complete first. | Let users do KYC. |
| IVMS Name Identifier Mismatch Fail | 200 | 200009 | Only TRSP clients may return this error, GTR users should directly use 200003. The user name does not match. | Let the user double-check the KYC name. |
| User in the sanction list Fail | 200 | 200010 | The user in the sanction list. | Popup warning to users. |
Functional Status Code
| Name | HTTP Status Code | Verify Status Code | Scenario | Description |
|---|---|---|---|---|
| Success | 200 | 100000 | Success | Operation Success or verify success |
| Pending | 200 | 100002 | Pending | Results are still incomplete, try again this API for a few seconds or minutes. |
You can directly check the Verify Status Code as verifyStatus parameter in the payload, and use the code to recognize the error flow to do.
Retry Policy
GTR does not have a retry policy. All Travel Rule requests can be invoked only once except for these 3 errors:
| Error Name | HTTP Status Code | Verify Status Code | Description |
|---|---|---|---|
| Initiator Server Fail | 500 | 100007 | Initiator Server error |
| Receiver Server Fail | 500 | 100008 | Receiver Server Error |
| GTR Server Fail | 500 | 100006 | GTR Server Error |
These 3 errors above occur when the counter-party VASP's server is down or throws unexpected errors.
We recommend retrying from your side with the same RequestId (requestId) every 30 seconds up to 5 times. You can also contact the GTR team for assistance with checking the errors.