Refund API

Testing Env

https://testpay.onlinepay.ai

POST

/v2/refund/apply

V2 Refund Apply endpoint. Uses V2 signing rules where signType is determined by the merchant's encryption config in the database.

Differences from V1

signType is NOT a request parameter — resolved from merchant DB config (encryption field)

version must be V2.0.0

All parameters participate in signing (sorted alphabetically)

Response includes sign and signType fields

Request

Body Params application/json

Example

{
    "merNo": 111111,
    "merOrderNo": "222222",
    "amount": "10.00",
    "tradeNo": "ONL02507071850393774",
    "sign": "4B18D0A324F0D006A84A495940857395",
    "notifyUrl": "https://www.example.com/refund/notify",
    "remark": "V2 refund request"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://testpay.onlinepay.ai/v2/refund/apply' \
--header 'Content-Type: application/json' \
--data '{
    "merNo": 111111,
    "merOrderNo": "222222",
    "amount": "10.00",
    "tradeNo": "ONL02507071850393774",
    "sign": "4B18D0A324F0D006A84A495940857395",
    "notifyUrl": "https://www.example.com/refund/notify",
    "remark": "V2 refund request"
}'

Responses

🟢200

application/json

Bodyapplication/json

Example

{
    "code": "00000",
    "message": "SUCCESS",
    "data": {
        "refundNo": "RF202605110001",
        "tradeNo": "ONL02507071850393774",
        "merNo": "111111",
        "merOrderNo": "222222",
        "refundAmount": "10.00",
        "refundCurrency": "USD"
    },
    "sign": "A1B2C3D4E5F6..."
}

Modified at 2026-05-27 09:25:35

Upload SEPA File API

Create Cardholder API

Refund API

Differences from V1#

Request

Request Code Samples

Responses

Differences from V1