Skip to main content
Search

Notify the Refund Transaction ID

After an accepted refund has been transferred on-chain, the BeneficiaryVASP calls this endpoint. GTR then sends REFUND_TXID_NOTIFY (callbackType: 23) to the OriginatorVASP.

Required implementation role: BeneficiaryVASP

  • Your role: BeneficiaryVASP
  • Counterparty: OriginatorVASP
  • Endpoint: POST /api/verify/v3/refund/notify-tx
curl --location --request POST '/api/verify/v3/refund/notify-tx' \
--cert-type P12 --cert ./certificate.p12:'[CERTIFICATE_PASSWORD]' \
--header 'Authorization: Bearer [LOGIN_TOKEN]' \
--header 'Content-Type: application/json' \
--data-raw '{
"refundBasicInfo": {"requestId": "beneficiary-exchange-550e8400-e29b-41d4-a716-446655440000"},
"blockchainTransaction": {
"network": "ETH", "ticker": "USDT", "txId": "0xrefund...32bc"
},
"refundFromAddress": {"address": "0x8ba1f109551bD432803012645Ac136ddd64DBA72", "tag": ""},
"refundValue": {"amount": "125.49", "gasFee": "0.01", "gasFeeTicker": "USDT"}
}'
FieldRequiredDescription
refundBasicInfo.requestIdYesExisting refund request ID.
blockchainTransaction.networkYesNetwork used for the refund transaction. Use a value from the Network List.
blockchainTransaction.tickerYesRefunded asset ticker. Use a value from the Ticker List.
blockchainTransaction.txIdYes for processingRefund transaction ID (not the original transfer TXID).
refundFromAddress.addressYesAddress from which the refund was sent, maximum 255 characters.
refundFromAddress.tagNoSource tag or memo, maximum 64 characters.
refundValue.amountYesActual refunded amount denominated in the asset specified by blockchainTransaction.ticker, represented as a decimal string.
refundValue.gasFeeYesNetwork fee paid for the refund, denominated in refundValue.gasFeeTicker and represented as a decimal string.
refundValue.gasFeeTickerYesTicker in which gasFee is denominated, maximum 64 characters. Use a value from the Ticker List.

Only the recorded BeneficiaryVASP may call this endpoint. The refund must have an accepted decision and must not already be completed or cancelled.

{
"verifyStatus": 100000,
"verifyMessage": "txId has been update and notified",
"data": null
}

What happens next

After the BeneficiaryVASP submits the refund TXID, the OriginatorVASP receives the Refund TXID Notification callback and reconciles the returned assets.