Refund TXID Notify Callback

Version: 3.0.0

Method

POST

Url

https://{YOUR_SERVICE_URL}/(refund_txid_notify: 23)

This API endpoint is for receiving the refund transaction notification. When the beneficiary VASP completes the on-chain refund transfer and notifies the refund tx (Refund API 2) via GTR, you as the originator VASP will receive this callback with the refund tx id, the refund-from address and the actual refund value, so that you can mapping the refund to your customer.

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Required)

Schema

[+]blockchainTransaction

RequiredObject

[+]refundBasicInfo

RequiredObject

[+]refundFromAddress

RequiredObject

[+]refundValue

RequiredObject

Example

{
  "refundBasicInfo": {
    "refundId": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5"
  },
  "refundValue": {
    "amount": 8e-18,
    "gasFee": 0.00021,
    "gasFeeTicker": "USDT"
  },
  "refundFromAddress": {
    "address": "E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp",
    "tag": "some of network like XRP required to input address tag (memo)"
  },
  "blockchainTransaction": {
    "ticker": "string",
    "txId": "string",
    "network": "string"
  }
}

Responses

Status HTTP Status: 200, VerifyStatus: 100000

default response

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

OptionalInteger (int32)

Example

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