TXID Existence Verify Callback

Version: 3.0.0

Method

POST

Url

https://{YOUR_SERVICE_URL}/(TXID exists verify: 9)

This API endpoint is for verify tx id existence, initiator will send you tx id exists verify via GTR, and you have to use tx id + beneficiary address + tag + network to identify one tx id is exists, *The reason using beneficiary address in txId check, is because originator mostly using hot-wallet to make transfer, so that you as originator should using txid + beneficiary address to identify who is originator.

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Optional)

Schema

address

RequiredString

address is beneficiary address (in all scenario)

Min Length0

Max Length256

Example

E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp

initiatorVasp

RequiredString

targetVaspCode here is the counter-party VASP that you want to send the travel rule request (*Not the assets transfer direction), vaspCode is GTR system's format

Min Length0

Max Length32

network

RequiredString

Network name in short symbol, the reference can check the table.

Min Length0

Max Length64

Example

XRP

requestId

RequiredString

requestId is the unique id for all transaction, the same travelrule-request invoke process flow should be using same requestId, the recommend format is: "[YOUR_VASP_NAME]-[UUIDv4]"

Min Length0

Max Length64

Pattern

[\w\d_=-]+

Example

testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5

tag

OptionalString

some of network like XRP required to input address tag (memo)

Min Length0

Max Length64

Example

466489710

ticker

RequiredString

ticker (coin) is the symbol of coin money, could refer to CMC

Min Length0

Max Length64

Example

USDT

txId

RequiredString

*if the travel rule is after on chain, then the txId is required. the tx id format type can check the table.

Min Length0

Max Length256

Example

d1029841dacb031098288b257b628a967eb963bbaccf954506ad0694219497a4

Example

{
  "initiatorVasp": "string",
  "ticker": "USDT",
  "address": "E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp",
  "requestId": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5",
  "txId": "d1029841dacb031098288b257b628a967eb963bbaccf954506ad0694219497a4",
  "tag": "466489710",
  "network": "XRP"
}

Responses

Status 200

OK

JSON Content

Schema

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

{
  "verifyStatus": 100000,
  "verifyMessage": "string"
}

Status HTTP Status: 200, VerifyStatus: 200007

TX ID Not found case

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

{
  "data": {},
  "verifyStatus": 100000,
  "verifyMessage": "string"
}

Status HTTP Status: 200, VerifyStatus: 100000

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

{
  "data": {},
  "verifyStatus": 100000,
  "verifyMessage": "string"
}

You have to use tx_id + beneficiary_address + tag + network to identify one tx_id exists in your system or not.

The reason using beneficiary_address in txId check is because originator mostly using hot-wallet to make transfer, so that you as originator should use include beneficiary_address in the txId check.

Response Example 1: Success

HTTP Status: 200, VerifyStatus: 100000

This response indicates that this tx_id do exist in your VASP.

{"verifyStatus": 100000,"verifyMessage": "Verify Success"}

Response Example 2: TX ID Not Found

HTTP Status: 200, VerifyStatus: 200007

{"verifyStatus": 200007,"verifyMessage": "TX ID Not Found"}