Create banking payin

POST

/order/v1/banking/order-payins

• Sandbox

Generate a PIX payin QR Code for a company account.

Authorizations

• Bearer

Parameters

Header Parameters

idempotency-key

required

string

Unique key for idempotent requests

Request Body ^required

object

externalId

required

External identifier of the payin

string

accountId

required

Receiver account identifier

string format: uuid

Example

f288ae0d-47fd-4207-aee4-0a384888bd96

paymentMethod

required

Payment method

string

Allowed values: PIX

Example

PIX

pixKey

PIX key used to generate the QR Code

string

Example

[email protected]

payer

Payer information

object

name

required

Payer full name

string

Example

John Doe

document

required

Payer document

object

type

required

Document type

string

Allowed values: CPF CNPJ

Example

CPF

number

required

Document number

string

Example

12345678901

Example

{
  "name": "John Doe",
  "document": {
    "type": "CPF",
    "number": "12345678901"
  }
}

amount

Payin amount. When omitted (or zero), the QR Code is generated with an open amount and the payer chooses it; the amount is set from the payment confirmation.

object

currency

required

Currency code

string

Allowed values: BRL

Example

BRL

value

required

Amount value as a numeric string. A JSON number is also accepted.

string

Example

10.00

description

Description of the payin

string

Example

Order #1234

expiration

Expiration time in seconds for the QR Code

number

Example

86400

Responses

200

object

id

required

Payin identifier

string

Example

c1c4c0b1-3bb8-4b1c-9e47-3f4a6f3a1b2c

externalId

required

External identifier

string

Example

external-123

status

required

Current status

string

Example

PENDING

errorMessage

Error message when order cannot proceed

string

Example

We were unable to complete your order at this time. Contact support for more information

qrcodeImageBase64

required

QR Code image (base64)

string

Example

iVBORw0KGgoAAAANSUhEUg...

qrcodeData

required

QR Code payload data

string

Example

000201010212...

expireDateTime

required

Expiration datetime (ISO)

string

Example

2024-01-01T12:00:00Z

amount

required

Amount information

object

currency

required

Currency code

string

Allowed values: BRL

Example

BRL

value

required

Amount value as a numeric string. A JSON number is also accepted.

string

Example

10.00

Example

{
  "currency": "BRL",
  "value": "10.00"
}

description

required

Payin description

string

Example

Order #1234

conciliationId

required

Conciliation identifier

string

Example

conciliation-123

400

Bad request

403

Forbidden

500

Internal error