1. Brazil
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
        POST
      • Create payment order - no query restrictions
        POST
      • Create payment order
        POST
      • Order inquiry
        POST
      • Account balance inquiry
        POST
      • Certificate query
        POST
  • webhook Request
    POST
  • Schemas
    • payin parameters
    • payin parameters v2
    • payout parameters
    • order query
    • balance query
    • webhook
    • proof query
    • payout manual
  1. Brazil

Create payment order

POST
{{host_payout_v2}}/pixkey
Determine whether the order creation is successful based on the http status code
200 Returns existing order information
201 Successful creation
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
** When creating a new order, the successful http status code is 201
** When mchOrderNo already exists, the http status code will be returned as 200
Both of the above cases will return order information

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://v2.payout.potawallet.com/pixkey' \
--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

Examples
{
        "orderNo": "PTV22024022417430080580517502972",
        "mchOrderNo": "TEST20240225014259240252749",
        "amount": 100,
        "fee": 0,
        "orderAmount": 100,
        "createdAt": 1708796580,
        "status": 11
}
🟢201success
🟠400Request error
Modified at 2026-02-10 13:13:04
Previous
Create payment order - no query restrictions
Next
Order inquiry
Built with