Skip to main content

Create new PIX withdrawal request by account

POST 
/api/withdraws/by_account

Creates a new withdrawal request using PIX as the payment method

Request​

Body

required
    value floatrequired

    Value to be paid

    account_number account_number (string)required

    Customer account's number

    account_type account_type (string)required

    Possible values: [CACC, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS]

    Customer account's type. Most commonly used are: CACC (Current Account), SLRY (Salary Account), SVGS (Savings Account) and TRAN (Transacting Account)

    branch branch (string)required

    Customer's bank account branch

    ispb ispb (string)required

    Customer's bank account ISPB. Unlike the 3-digit bank code, the ISPB is an 8-digit internal code of the brazilian financial system used for transactions between banks and fintechs. Click here to check the ISPB of the institutions participating in Pix.

    description description (string)required

    Description of the payment

    client_name client_name (string)required

    Customer's name

    client_document client_document (string)required

    Customer's document (CPF or CNPJ)

    merchant_id merchant_id (string)required

    Merchant's ID for conciliation

Responses​

Successful operation

Schema
    status status (string)

    Possible values: [pending, failed]

    Transaction's status

    message message (string)

    Payment's description

    transaction_uuid transaction_uuid (string)

    Transaction's UUID

Loading...