Initiate a payment using bank information.

This endpoint allows requesting a Pix payment order (cash-out) using the creditor's bank details (ISPB code, document, branch, account number, account type, name).

curl --location --request POST 'https://infopago.apidog.io//pix/payments/manu' \ --header 'x-idempotency-key;' \ --header 'Content-Type: application/json' \ --data-raw '{ "priority": "HIGH", "description": "string", "paymentFlow": "INSTANT", "expiration": 600, "creditorAccount": { "ispb": "string", "issuer": "string", "number": "string", "accountType": "SLRY", "document": "string", "name": "string" }, "payment": { "currency": "BRL", "amount": 0 }, "ispbDeny": [ "string" ] }'

Requisição

Parâmetros Header

x-idempotency-key

string

requerido

Unique request identifier to support idempotency.

Parâmetros Bodyapplication/json

priority

enum<string>

opcional

When the parameter is set to 'HIGH,' it is processed instantly (bypassing the processing queue). The value 'HIGH' is only allowed when the 'creditorDocument' field is defined.

Valores permitidos:

HIGHNORM

description

string

opcional

paymentFlow

enum<string>

opcional

Default value is INSTANT.

INSTANT - Payment will happen immediately

APPROVAL_REQUIRED - Payment only will happen when the order was approved.

Valores permitidos:

INSTANTAPPROVAL_REQUIRED

Padrão:

INSTANT

expiration

integer <int64>

opcional

Maximum time (seconds) that an operation can remain in the queue waiting for processing before being cancelled.

>= 1<= 10800

Padrão:

600

creditorAccount

object (CreditorData)

requerido

ispb

string

opcional

Identificador de Sistema de Pagamentos Brasileiro (Brazilian Payment System Identifier) is a unique and standardized numerical code that identifies each financial institution in the payment system in Brazil. It is used to identify banks, payment institutions and other entities authorized to operate in the Brazilian financial system.

issuer

string

opcional

Agency Code of the issuing account without digit. (Agency refers to the branch designated for customer service, general public, and credit cooperative members, engaged in the institution's activities, and cannot be mobile or transient).

number

string

opcional

It must be filled in with the recipient user's account number, including the verification digit (if applicable). If there is an alphanumeric value, it should be converted to 0.

accountType

AccountType

opcional

document

string

opcional

Owner account document.

name

string

opcional

Owner account name.

payment

object

requerido

currency

enum<string>

opcional

Valores permitidos:

BRL

amount

number <double>

opcional

ispbDeny

array[string]

opcional

List of codes ISPB (Identificador de Sistema de Pagamentos Brasileiro) to which payments will not be allowed.

Examples

Respostas

🟢202Accepted

application/json

Accepted

Body

endToEndId

string

opcional

The "endToEndId" field refers to a unique identifier that can be used to track and associate a specific transaction throughout the lifecycle of the operation. The term "end-to-end" pertains to the ability to trace the transaction from beginning to end, ensuring data integrity along the way.

eventDate

string <date-time>

opcional

number

opcional

payment

object

opcional

currency

enum<string>

opcional

Valores permitidos:

BRL

amount

number <double>

opcional

type

string

opcional

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠412412

🟠422Parameter Error

🟠429429

🔴500Server Error

🔴503Service Unavailable

🔴504Gateway Timeout