- Getting Started
- Fiat Collection
- Overview
- Pelago Cashier Mode
- Pelago Direct Mode
- Crypto Collection
- Common Collection
Refund
POST
/openapi/crypto/refund
Request
Authorization
Header Params
X-App-Key
string
required
Example:
{{merchant-app-key}}
Body Params application/json
data
object
required
merchantId
string
required
pelagoOrderId
string
required
merchantRefundId
string
required
Match pattern:
^[a-zA-Z0-9_-]+$
refundAmount
number
required
refundReason
string
required
timestamp
string
required
Match pattern:
^\d{13}$
nonce
string
required
notifyUrl
string
optional
signature
string
required
Example
{
"data": {
"merchantId": "string",
"pelagoOrderId": "string",
"merchantRefundId": "string",
"refundAmount": 0,
"refundReason": "string",
"timestamp": "string",
"nonce": "string",
"notifyUrl": "string"
},
"signature": "string"
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://prod-cn.your-api-server.com/openapi/crypto/refund' \
--header 'X-App-Key: {{merchant-app-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"data": {
"merchantId": "string",
"pelagoOrderId": "string",
"merchantRefundId": "string",
"refundAmount": 0,
"refundReason": "string",
"timestamp": "string",
"nonce": "string",
"notifyUrl": "string"
},
"signature": "string"
}'
Responses
🟢200OK
*/*
Body
code
string
required
data
object
required
scenarioCode
string
required
pelagoRefundId
string
required
merchantRefundId
string
required
refundAmount
string
required
refundTime
string
required
refundAddress
string
required
refundReason
string
optional
notifyUrl
string
optional
msg
string
required
Example
{
"code": "string",
"data": {
"scenarioCode": "string",
"pelagoRefundId": "string",
"merchantRefundId": "string",
"refundAmount": "string",
"refundTime": "string",
"refundAddress": "string",
"refundReason": "string",
"notifyUrl": "string"
},
"msg": "string"
}
Modified at 2025-06-13 03:33:14