Create payment order - no query restrictions

Determine whether the order creation is successful based on the http status code:
200 Success
201 Indicates that the order is submitted repeatedly, and the previous order information will be returned
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

Request parameter reference:
accountType: User selection required
6. SLRY, salary account
Salary - Conta Salário
7. SVGS, savings account
Savings - Conta de Poupança.
8. CACC, current account
Current - Conta Corrente
9. TRAN, prepaid account
Transacting Account - Conta de Pagamento pré-paga
The front end needs to be set as a drop-down option, the options are: Conta Salário, Conta de Poupança, Conta Corrente, Conta de Pagamento pré-paga
ispb: User selection required. The front end should display Número-Código + bank name, for example: 341 ITAÚ UNIBANCO S.A.
The front end needs to be set as a drop-down option and it is recommended to allow fuzzy search

How do users know their bank account information?
In your bank app account information/personal information, it is usually in the upper right corner.

Request

Header Params

Body Params application/json

Example

{
    "mchOrderNo": "test-payout-000035",
    "notifyUrl": "https://webhook.site/8f874726-a8c3-458b-8525-0abb921f243a",
    "amount": 100,
    "creditor": {
        "ispb": "60701190",
        "issuer": "2000",
        "accountNo": "791185",
        "accountType": 8,
        "idNumber": "47011122210",
        "accountName": "Customer Name"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200success

application/json

Bodyapplication/json

Example

{
    "OrderNo": "PT82023121421307743984072",
    "mchOrderNo": "test-payout-00007",
    "Identifier": "E1234567890",
    "orderAmount": 100000,
    "amount": 103500,
    "fee": 3500,
    "status": 1,
    "createdAt": 1702600239,
    "performedAt": 1702600239
}

🟠400Request error