Refund (Direct Payment)

Changed on

Initiate a refund for the direct address payment order, which is only applicable to the direct address payment order.

post/v1/pay/address/refund

Request

  • Base URL
    https://openplatform.gateapi.io
  • URL
    https://openplatform.gateapi.io/v1/pay/address/refund
  • Auth
    none declared. Required headers: X-GatePay-Certificate-ClientId, X-GatePay-Signature, X-GatePay-Timestamp, X-GatePay-Nonce

Headers

X-GatePay-Certificate-ClientIdstring required

Merchant client ID, obtained from GatePay platform

X-GatePay-Signaturestring required

HMAC-SHA256 signature for request validation

X-GatePay-Timestampstring required

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

X-GatePay-Noncestring required

Random nonce for replay attack prevention

Request body

prepayIdstring required

The ID of the corresponding payment order

refundAmountstring required

The amount to be refunded

refundReasonstring

The reason for the refund

receiverIdinteger required

The Gate user ID of the recipient of the refund for address payment

refundRequestIdstring required

Merchant refund request ID

Response

SUCCESS

statusstring

Status

codestring

Business code

errorMessagestring

Error message

Example response

{
  "status": "SUCCESS",
  "code": "000000"
}

Changes

    • breaking

      added the new required request property

    • breaking

      the request property type changed from string to integer, and format from no format to int64

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status