Payout

When performing a payout, the customer initiates a payout and then just waits for the funds to be credited to their account. The customer themself doesn't participate in the payout processing procedure.

Countries and regions Brazil
Payment currencies BRL, USD
Payment amount limits Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time Contact your key account manager at Monetix for details.
Currency conversion On the Monetix side
Refund
Onboarding and access fee Contact your key account manager at Monetix for details.

Operations support

Interfaces
Payment Page Gate Dashboard
Payout

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section, and then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Payout by using Gate

General information

To perform a payout by using Gate with the PIX payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Accept the callback with the payout result from the payment platform.

The following picture provides the details of the payout processing flow in the PIX payment method.

Figure 1. Payout processing flow when performing a payout by using Gate
  1. The customer initiates a payout in your system.
  2. Your system sends the payout request to the Monetix payment platform.
  3. The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
  4. The payment platform processes the request and forwards it to the provider service.
  5. The provider service informs the payment platform about the payout result.
  6. The payment platform sends a callback with the payout result to your system.
  7. Your system sends the payout result to the customer.

Request

This section provides the instructions on how to build the request for payout with the PIX payment method.

HTTP request method POST
Request body format JSON
API endpoint /v2/payment/pix/payout
Table 1. Basic parameters of a payout request

strictly required—the parameter must be in the initial request.

✱—the parameter may not be required in some cases. Contact your account manager at Monetix for details.
ObjectObject/Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

phone
string
strictly required✱

Customer's phone number.

Example: 1234567890123

day_of_birth
string
strictly required✱

Customer's date of birth in the DD-MM-YYYY format.

Example: 22-11-2000

address
string
strictly required✱

Customer's address (street, building number, apartment number, etc.). The address must contain only letters, numbers and whitespace characters.

Example: 20 Baltimore str.

city
string
strictly required✱

Customer's city.

Example: London

account_id
string
strictly required

PIX key ID the customer registers to use PIX. PIX key can be one of the following: CPF/CNPJ/phone number/email/EVP. If PIX key ID is a phone number, then it should be sent with a "+" sign, without any spaces or punctuation marks. If PIX key ID is a document number (CPF/CNPJ), then it should contain only digits, without any spaces or punctuation marks. Contact your Monetix key account manager to find out which of the IDs you should provide.

Example: 123456789 (for the document number) or +5531231231111 (for the phone number)

identify
object
strictly required

doc_number
string
strictly required

Customer's CPF number (contains 11 digits) or CNPJ number (contains 14 digits). The number should contain only digits, without any spaces or punctuation marks. Contact your key account manager at Monetix to find out which of the numbers you should provide.

Example: 12345678901

account
object
strictly required✱

number
string
strictly required✱

Customer's account number.

Example: 123456

type
string
strictly required✱

Type of the customer's bank account. Type of the bank account must relay to the corresponding account number in the number parameter. Otherwise, the payment will be declined on the provider side.

Possible values: Savings Bank or Checking Account.

Example: Savings Bank

bank_id
integer
strictly required✱

Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for payout.

Example: 57111

bank_branch_code
string
strictly required✱

Code of the customer's bank branch.

Example: 123456

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: USD

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 USD must be sent as 10000

You can also add any other optional parameters to the payout request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a payout with the PIX payment method:

Figure 2. Example of the payout request body
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com",
        "phone": "1234567890123",
        "day_of_birth": "22-11-2000",
        "address": "20 Baltimore str.",
        "city": "London",
        "account_id": "123456789",
        "identify": {
            "doc_number": "12345678901"
        }
    },
    "account": {
        "number": "123456",
        "type": "Savings Bank",
        "bank_id": 57111,
        "bank_branch_code": "123456"
    },
    "payment": {
        "currency": "USD",
        "amount": 10000
    }
}

Callback

In the PIX payment method, the payment platform returns the payout result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed payout.

Figure 3. Example of the data from a successful payout callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "pix",
        "sum": {
            "amount": 10000,
            "currency": "USD"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "USD"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "USD"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined payout.

Figure 4. Example of the data from a declined payout callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "pix",
        "sum": {
            "amount": 10000,
            "currency": "USD"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "USD"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "USD"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Payout by using Dashboard

To make a payout through Dashboard, the merchant sends a request and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard:
  • single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
  • as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

Banks available for payout

Supported banks

In the PIX payment method, payments are performed through the banks the payment method supports. For the payout to be performed, your request must contain the ID of the customer's bank in the account.bank_id parameter.

The table below lists the banks available for payout in the PIX payment method.

Table 2. Banks available for payout
BankID
Banco Agibank S.A.57111
BANCO BTG PACTUAL S.A.57081
Banco C6 S.A.57141
Banco Cooperativo Sicredi S.A.57061
Banco do Brasil1781
Banco do Estado do Rio Grande do Sul S.A. BANRISUL57071
Banco Inter S.A.57101
Banco Itaú S.A.57031
Banco Original S.A.57121
Banco Safra S.A.57051
Bradesco1771
Caixa Econômica Federal1801
Neon Pagamentos57091
Next Tecnologia e Serviços Digitais57041
Nubank57131
Santander Brasil1761

The table with the list of banks is provided for informational purposes only. It may change without notice. To get the current list of banks the PIX payment method supports, contact your key account manager at Monetix.