Virtual accounts

List virtual accounts

get
/banking/virtual_accounts

List all available virtual accounts

Query parameters
entity_idstring · uuidOptional

Unique identifier

bank_account_idstring · uuidRequired

Unique identifier

statusstringOptional

Status of the virtual account

beforestringOptional

Before

afterstringOptional

After

limitintegerOptional

Limit

Responses
200

VirtualAccounts

application/json
get
/banking/virtual_accounts

Show virtual account

get
/banking/virtual_accounts/{id}

Shows a virtual account

Path parameters
idstring · uuidRequired

Unique identifier

Responses
200

Virtual account

application/json
get
/banking/virtual_accounts/{id}

Create virtual account

post
/banking/virtual_accounts

Creates a virtual account

Body

Creates a virtual account params

bank_account_idstringRequired

Bank Account ID

descriptionstringRequired

Description

Responses
post
/banking/virtual_accounts

Update virtual account parameters

put
/banking/virtual_accounts/{id}

Update virtual account parameters

Path parameters
idstring · uuidRequired

Unique identifier

Body

Updates an account parameters params

automatic_refund_for_person_deadbooleanOptional

Automatic refund for deceased individuals

automatic_refund_for_person_invalid_tax_numberbooleanOptional

Automatic refund for invalid tax number

automatic_refund_for_person_underagebooleanOptional

Automatic refund for underage

in_block_for_legal_entitybooleanOptional

In block for legal entity origin

in_block_for_pix_qrcode_different_amount_paymentbooleanOptional

In block for qrcode different amount payment

in_block_for_pix_qrcode_different_counterparty_bank_accountbooleanOptional

In block for qrcode different counterparty bank account

in_block_for_pix_qrcode_different_tax_numberbooleanOptional

In block for qrcode different tax number

in_block_for_pix_qrcode_duplicated_paymentbooleanOptional

In block for qrcode duplicated payment

in_block_for_unauthorized_participantbooleanOptional

In block for unauthorized participant

in_block_for_unidentified_depositbooleanOptional

In block for unidentified deposit

out_block_for_legal_entitybooleanOptional

Out block for legal entity destination

out_blockedbooleanOptional

Out blocked

Responses
put
/banking/virtual_accounts/{id}

Sum amount and count virtual account

get
/banking/virtual_accounts/{id}/balances

Sum amount and count virtual account

Path parameters
idstring · uuidRequired

Unique identifier

Query parameters
at_datetimestringOptional

At datetime

Responses
200

BalanceResponse

application/json
get
/banking/virtual_accounts/{id}/balances

List transactions

get
/banking/virtual_accounts/{id}/transactions

List transactions

Path parameters
idstring · uuidRequired

Unique identifier

Query parameters
external_idstringOptional

External ID

reconciliation_idstring · uuidOptional

Unique identifier

from_datetimestring · date-timeRequired

Datatime schema

to_datetimestring · date-timeRequired

Datatime schema

beforestringOptional

Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ==
afterstringOptional

Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==
Responses
200

Transactions

application/json
get
/banking/virtual_accounts/{id}/transactions

Last updated

Was this helpful?