Payment-Gateway-OpenApi
  1. Crypto Collection
Payment-Gateway-OpenApi
  • Getting Started
  • Fiat Collection
    • Overview
    • Pelago Cashier Mode
      • Cashier Mode Introduction
      • Create Pelago Order
    • Pelago Direct Mode
      • Direct Mode Introduction
      • Get Rate
      • Get Product
      • Create Order
      • Get Order Info
      • Order Notify
  • Crypto Collection
    • Overview
    • Create Order
      POST
    • Refund
      POST
    • Withdraw
      POST
  • Common Collection
    • Check Order Info
      POST
  1. Crypto 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
max length 32
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
*/*
OK
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
Previous
Create Order
Next
Withdraw
Built with