Refund Request

• Endpoint: POST /delSuffixStart6
• Tags: Collection Service

Description

Note that the request address does not contain the interface description in brackets

Parameters

Field	In	Type	Required	Constraints	Description
sign	header	string	Yes

Parameter Examples

• sign: "FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="

Request Body

Content-Type: application/json

Field	Type	Required	Constraints	Description	Enum
merchantId	string	Yes	maxLength: 30	Merchant ID assigned by PayerMax.
bizType	string	Yes	maxLength: 30	Business type. Value 'refundApply' needs to be passed here.
version	string	Yes	maxLength: 5	API version, currently always pass '2.1'.
refundId	string	Yes	maxLength: 64	Refund request ID.
orderId	string	Yes	maxLength: 64	Original merchant order ID.
amount	string	Yes	maxLength: 64	Refund amount, must be equal to the original payment amount. Currently partial refund is not supported.
currency	string	Yes	maxLength: 3	Currency code in capital alphabet. 【Country & Region Codes】
callbackUrl	string	No	maxLength: 256	Refund result callback URL.
comments	string	No	maxLength: 256	Refund comments.
email	string	No	maxLength: 32	Brazil’s Lottery and Boleto payment methods for refunds, send to the mailbox to accept the refund information collection page.

Example

{
  "merchantId": "SP12345678",
  "bizType": "refundApply",
  "version": "2.1",
  "refundId": "2018111211260556846",
  "orderId": "1535433555559",
  "amount": "1000.00",
  "currency": "INR",
  "callbackUrl": "https://***.com/revMsg",
  "comments": "Sales return",
  "email": "123@gmail.com"
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
bizCode	string	Yes	maxLength: 10	Response code.
message	string	No	maxLength: 256	Response description, interface error prompt.
data	object	Yes		Response body,refer to the below【data parameters】
data.refundId	string	Yes	maxLength: 64	Merchant refund request serial number.
data.tradeNo	string	Yes	maxLength: 64	The payermax original Platform Order ID.
data.orderId	string	Yes	maxLength: 64	The original Merchant Order ID.
data.status	number	Yes		Refund status: 0 - initial refund, 1 - refund successful, 2 - refund failed.
data.errorCode	string	No	maxLength: 64	Refund error code.
data.errorMsg	string	No	maxLength: 256	Refund error result.

Response Example

{
  "bizCode": "0000",
  "data": {
    "tradeNo": "20220914153025TI2536162084804117",
    "refundId": "2018111211260556846",
    "orderId": "1535433555559",
    "status": 0
  }
}