Skip to main content

Create Pix Payment by Bank Account

POST 
/v2/pix/payments/by-account/instant-billing

Initiate a new pix payment using a bank account. First, create a Decoded Pix Account ID at the endpoint /pix/payment/decode/by-account. Then, use the decoded_pix_account_id to enter the pix payment's information in the request body and execute.

Request​

Header Parameters

    x-include-replay-protection-schema string

    The replay-protection-schema allows the user to choose between 3 options:

    • If there's no value: The default protection checks that the values in this request are equal: { method, params, path, query, body, userId }. This means that if a request repeats the same values, it will be blocked.
    • 'nonce': The nonce and { method, params, path, query, body, userId } value are checked. When the protection schema is this, requests will be OK if this nonce value is different in each request.
    • 'x-transaction-uuid': The transactionId and { method, params, path, query, body, userId } value are checked. Requests will be OK if this x-transaction-uuid value is different in each request.
    • 'x-transaction-uuid&nonce' or 'nonce&x-transaction-uuid': The nonce, transactionId value and { method, params, path, query, body, userId } are checked, i.e. if requests are repeated the same value in both fields, they will be blocked. But if any field has a different value, the request is OK.

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the requisition. All requisitions must have an identifier.

Body

required
    person_type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Person type:

    • NATURAL_PERSON.
    • LEGAL_PERSON.

    document stringrequired

    Person's document (CPF or CNPJ).

    bank_ispb string

    Bank ISPB code (8 digits)

    branch string

    Account branch (4 digits).

    account_number string

    Account number (between 1 and 20 digits).

    account_type string

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

    Account type:

    • CACC: Checking account.
    • SLRY: Salary.
    • SVGS: Savings.

    value numberrequired

    Value in R$ cents.

    payment_date YYYY-MM-DD

    Payment date.

    description string

    User defined payment description.

Responses​

Payment accomplished.

Schema
    id stringrequired

    Payment UUID.

    operation_id string

    Operation UUID. Used to get receipt and track the transaction. This will not be returned if the payment has been scheduled.

    state stringrequired

    Possible values: [PENDING, WAITING, CONFIRMED, ERROR, FAILED, CANCELED, SCHEDULED]

    Payment state.

    value numberrequired

    Value in R$ cents.

    payment_date date-timenullable

    Schedule a day to execute payment. Use null to send payment right now.

    description stringnullable

    User defined payment description.

    created_at date-timerequired

    Payment created date.

Loading...