Check Individual Virtual Account
Availability: Argentina | Brazil | Mexico
Availability Offline: Chile
GET {{api_base_url}}/api/virtual-account/:externalId
You can retrieve the current status and details of a virtual account through the Localpayment API.
Note
Virtual accounts in Chile currently support only offline operations. For full details on how to proceed, refer to the Offline Virtual Account Creation article.
Request
To retrieve the details of a virtual account by API, send a GET request to the /api/virtual-account/:externalId endpoint, including all required parameters.
Headers
Authorization
String
Required
Mandatory. JWT token in format Bearer eyj0.... For more information about authentication, please refer to Authentication.
Path Parameters
externalId
String
Required
A unique identifier generated by your system to track the transaction (alphanumeric and hyphens). We recommend using UUID4 to ensure uniqueness.
Request Examples
Below is an example using curl:
curl --location \
--request GET '{{api_base_url}}/api/virtual-account/de14bcf2-15ee-22e3-ab59-99c3fcba31e8/' \
--header 'Authorization: Bearer <your_access_token>'Response
A successful request returns an HTTP status code 200, along with the updated status of the virtual account. In contrast, if an error occurs, the API responds with an HTTP status code in the 40X range, and detailed error information is provided within the status object.
Body Parameters
externalId
String
A unique identifier generated by your system to track the transaction (alphanumeric and hyphens). We recommend using UUID4 to ensure uniqueness.
a79aabec-16c6-4a84-8abe-be2dcd2e07a1
internalId
String
Localpayment transaction identifier.
d710312c-8c3f-4b65-8e62-7f83eeba321a
accountNumber
String
Localpayment account number.
beneficiary
Object
Information about the virtual account beneficiary.
beneficiary.type
String
Beneficiary type.
COMPANY, INDIVIDUAL
646011319800152616
beneficiary.name
String
Beneficiary name.
beneficiary.document
Object
Beneficiary documentation.
beneficiary.document.type
String
The type of identity document, such as a National Identity Number, Social Security Number, or Driver's License, depending on the country of issuance.
beneficiary.document.id
String
Identity document number (usually a number). This must be a valid number according to the rules for the specific document type.
beneficiary.lastName
String
Beneficiary's last name.
beneficiary.fullName
String
Beneficiary's full name.
beneficiary.bank
Object
Beneficiary Bank Information.
beneficiary.bank.branch
Object
Bank branch details.
beneficiary.bank.branch.code
String
Branch code.
beneficiary.bank.account
Object
Beneficiary's bank account details.
beneficiary.bank.account.number
String
Virtual Account Number (VAN) to which the customer must complete the payment.
646011319800152616
beneficiary.bank.account.aliases
Array of objects
Configured aliases for a virtual account. Available only for virtual accounts in Brazil.
beneficiary.bank.account.aliases.type
String
The type of alias (e.g., E).
E , P or RandomKeyCode
P
beneficiary.bank.account.aliases.value
String
Alias value.
beneficiary.bank.account.owner
Object
Account owner's document details.
beneficiary.bank.account.owner.document
Object
Account owner's document
status
Object
Operation status.
status.code
String
Status code
status.description
String
Status description
status.detail
String
Additional status information.
errors
Array of objects
Array of errors that occurred during the transaction. If the transaction was successful, this array will be empty.
Response Examples (INPROGRESS)
{
"currency": "ARS",
"externalId": "de14bcf2-15ee-22e3-ab59-99c3fcba31e8",
"internalId": "ab111111-88cf-4ac3-8fe5-49610795a33d",
"accountNumber": "{{YourAcountNumber}}",
"beneficiary": {
"type": "INDIVIDUAL",
"name": "John",
"document": {
"type": "CUIL",
"id": "27-32548697-5"
},
"fullName": "John Doe",
"lastName": "Doe"
},
"status": {
"code": "100",
"description": "INPROGRESS",
"detail": "Virtual account in progress"
},
"errors": []
}Response Examples (COMPLETED)
{
"currency": "ARS",
"externalId": "de14bcf2-15ee-22e3-ab59-99c3fcba31e8",
"internalId": "ab111111-88cf-4ac3-8fe5-49610795a33d",
"accountNumber": "{{YourAcountNumber}}",
"cvu": "0000472900016608609046",
"beneficiary": {
"type": "INDIVIDUAL",
"name": "John",
"document": {
"type": "CUIL",
"id": "27-32548697-5"
},
"address": {
"street": "Calle 34",
"number": "123",
"city": "Quilmes",
"state": "Buenos Aires",
"country": "Argentina",
"zipCode": "7400",
"comment": "Area centro"
},
"bank": {
"branch": {},
"account": {
"number": "0000472900016608609046",
"aliases": [],
"owner": {
"document": {}
}
}
},
"fullName": "John Doe",
"lastName": "Doe"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "Virtual account has been created"
},
"errors": []
}Error Response Example
A "non-existent virtual account" refers to a situation where the externalId provided in the request does not match any record in the virtual accounts database. This typically happens when:
The account has not been created or registered yet.
There was a typo or formatting issue in the externalId.
The account was deleted.
{
"timestamp": "2025-01-06T23:03:33.168+00:00",
"status": 404,
"error": "Not Found",
"message": "Virtual account not found with externalId: dc21d8be-f8cc-4bb3-ac4a-8875f48a0f041",
"path": "/virtual-account/dc21d8be-f8cc-4bb3-ac4a-8875f48a0f041"
}Last updated
Was this helpful?