Initiate merchant refund

post

https://acquirersandbox.rp-2023app.com/openapi/v2/refund/create

Initiate a refund for a previously created order. Returns the acquirer
refund identifier and the initial refund status (e.g. REFUNDING). Use
this API to submit merchant-initiated refunds.

Body Params

create refund order request

merchantRefundSn

string

required

^[a-zA-Z0-9_\-|*@]+$

Merchant's external refund identifier (merchantRefundSn).

Max length: 64 characters.
Allowed characters: letters, numbers and _ - | * @

outerOrderSn

string

required

Merchant's original order identifier (outerOrderSn).
Use this to link the refund to the original payment.

reason

string

required

Refund reason provided by the merchant.
This should clearly explain why the refund is requested.

refundAmount

number

Used for partial refund of order.
if not specified, it defaults to a full refund.

Headers

X-R-Ts

string

required

request timestamp in milliseconds

X-R-Ak

string

required

merchant's appKey

X-R-Signature

string

required

request signature

X-R-Key-Version

string

merchant's private key version, default is 1

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

200OK

400request param invalid or format error

401JWT has expired or JWT is illegal

403request ip not in the white list

429exceed api frequest frequency limit