PIX Payout API

Testing Env

https://testpay.onlinepay.ai

POST

/v2/payout

OnlinePay will obtain the HTTP Header referer to verify the website source. The website source must be configured by OnlinePay to be verified. If you do not access the interface through a browser, you need to actively add a referer.

Request

Header Params

Body Params application/json

Example

{
    "merNo": 840698790,
    "merOrderNo": "PO20260522003",
    "currencyCode": "BRL",
    "sourceAmount": "100.00",
    "withdrawType": "5",
    "returnUrl": "https://merchant.com/return",
    "notifyUrl": "https://merchant.com/notify",
    "sign": "A1B2C3D4E5F6...",
    "signType": "RSA256",
    "version": "V2.0.0",
    "ipAddress": "192.168.1.1",
    "cardNo": "12345678900",
    "pixKey": "12345678900",
    "pixType": "CPF"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://testpay.onlinepay.ai/v2/payout' \
--header 'paymentType: PAYOUT' \
--header 'Referer;' \
--header 'User-Agent;' \
--header 'Authorization;' \
--header 'lang;' \
--header 'orderType;' \
--header 'Content-Type: application/json' \
--data '{
    "merNo": 840698790,
    "merOrderNo": "PO20260522003",
    "currencyCode": "BRL",
    "sourceAmount": "100.00",
    "withdrawType": "5",
    "returnUrl": "https://merchant.com/return",
    "notifyUrl": "https://merchant.com/notify",
    "sign": "A1B2C3D4E5F6...",
    "signType": "RSA256",
    "version": "V2.0.0",
    "ipAddress": "192.168.1.1",
    "cardNo": "12345678900",
    "pixKey": "12345678900",
    "pixType": "CPF"
}'

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "code": "00000",
    "message": "SUCCESS",
    "data": {
        "payCode": 0,
        "tradeNo": "T2026052200003",
        "merorderNo": "PO20260522003"
    }
}

Modified at 2026-05-26 02:48:30

Bank Account Payout API

PER Transfer Payout API