Refund Request Query Callback

Version: 3.0.0

Method

POST

Url

https://{YOUR_SERVICE_URL}/(refund_request_query: 21)

This API endpoint is for refund request inquiry. When a beneficiary VASP submits a refund request (Refund API 1) via GTR, you as the originator VASP will receive this callback with the refund details (original blockchain transaction, declared refund value, refund reason and beneficiary address). Please review the request and submit your refund decision (accept/reject) via Refund API 4.

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Required)

Schema

[+]beneficiaryAddress

RequiredObject

[+]blockchainTransaction

RequiredObject

[+]refundBasicInfo

RequiredObject

[+]refundDeclaredValue

RequiredObject

[+]refundReason

RequiredObject

Example

{
  "refundBasicInfo": {
    "refundId": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5"
  },
  "blockchainTransaction": {
    "network": "string",
    "ticker": "string",
    "txId": "string"
  },
  "refundDeclaredValue": {
    "amount": 8e-18
  },
  "refundReason": {
    "reason": "Originator KYC verification could not be completed within the SLA window",
    "reasonType": "ORIGINATOR_TRAVEL_RULE_INCOMPLETE"
  },
  "beneficiaryAddress": {
    "address": "E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp",
    "tag": "some of network like XRP required to input address tag (memo)"
  }
}

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"
}