1. v1
Potapay(English)
  • Interface description
  • appoint
  • Signature & Signature Algorithm
  • Test parameter
  • Error code
  • v1
    • Create invoice order
      POST
    • Create a payment order
      POST
    • Order inquiry
      POST
    • Account balance inquiry
      POST
    • Certificate query
      POST
  • v2
    • Mexico
      • List of Mexican banks
      • Test parameters
      • Query
        • Order Inquiry
        • Account Balance Inquiry
        • Voucher Inquiry
      • Create a invioce order
      • Create a payment order
    • Brazil
      • Create invioce order
      • Create payment order - no query restrictions
      • Create payment order
      • Order inquiry
      • Account balance inquiry
      • Certificate query
  • webhook Request
    POST
  • Schemas
    • payin parameters
    • payin parameters v2
    • payout parameters
    • order query
    • balance query
    • webhook
    • proof query
    • payout manual
  1. v1

Create a payment order

POST
{{host}}/payout/v1/apply
Determine whether the order creation is successful based on the http status code
200 Success
400 Parameter error
401 Account or IP cannot be used
500 Server status abnormal
503 Server status abnormal
For specific error codes, refer to the error code
** After the order is created, please do not cancel

Request

Header Params

Body Params application/json

Example
{
    "mchOrderNo": "test-payout-000030",
    "notifyUrl": "https://webhook.site/8f874726-a8c3-458b-8525-0abb921f243a",
    "amount": 1000,
    "accountName": "jack",
    "accountNo": "12139143965",
    "accountType": 1,
    "phone": "+551234567890",
    "email": "FrancesStanley@Gabspot.com",
    "remark": "ullam qui laborum iste vitae."
}

Request Code 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 --globoff 'https://gateway.potawallet.com/payout/v1/apply' \
--header 'X-Account: b5373276-3924-4fbb-8845-acd15e910543' \
--header 'X-Signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mchOrderNo": "test-payout-000030",
    "notifyUrl": "https://webhook.site/8f874726-a8c3-458b-8525-0abb921f243a",
    "amount": 1000,
    "accountName": "jack",
    "accountNo": "12139143965",
    "accountType": 1,
    "phone": "+551234567890",
    "email": "FrancesStanley@Gabspot.com",
    "remark": "ullam qui laborum iste vitae."
}'

Responses

🟢200Success
application/json
Bodyapplication/json

Example
{"orderNo":"PO20230802071913-00129","orderAmount":1000,"amount":1000,"fee":0}
🟠400请求有误
Modified at 2026-02-10 12:59:50
Previous
Create invoice order
Next
Order inquiry
Built with