Payout via Virtual Account

POST

/v1/virtual-account/order/payout

Make a payout to a bank account via Virtual Account.

Request

Body Params application/json

Examples

BRLNGNMXN

{
    "requestId": "PAYOUT20250828150000812",
    "currency": "BRL",
    "amount": 360,
    "accountNumber": "pixkey1234556"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

BRLNGNMXN

curl --location --request POST '/v1/virtual-account/order/payout' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "PAYOUT20250828150000812",
    "currency": "BRL",
    "amount": 360,
    "accountNumber": "pixkey1234556"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "status": 0,
    "message": "string",
    "data": {
        "requestId": "string",
        "orderId": "string",
        "status": "string"
    },
    "traceId": "string"
}

Query bank info by account number

Refund Virtual Account Order