Refund API V3 — submit (API 1)

Version: 3.0.0

Method

POST

Url

https://platform.globaltravelrule.com/api/verify/v3/refund/submit

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

Schema

supportId

OptionalString

Example

supportId=string

Request Body (Required)

Schema

[+]beneficiaryAddress

RequiredObject

[+]blockchainTransaction

RequiredObject

[+]originatorVaspInfo

RequiredObject

[+]refundBasicInfo

RequiredObject

[+]refundDeclaredValue

RequiredObject

[+]refundReason

RequiredObject

Example

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

Responses

Status 200

OK

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

OptionalInteger (int32)

Example

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