Check Batch Virtual Account

Availability: Argentina | Mexico

GET {{api_base_url}}/api/virtual-account-batch/:externalId

---

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.

Once a virtual account batch creation request has been submitted, you can retrieve its current status and details via the API. This is useful for tracking the progress of the batch processing, validating individual account creation statuses, and reviewing any possible errors.

Request

To retrieve batch information, send a GET request to the /api/virtual-account-batch/:externalId endpoint, replacing externalId with the unique identifier you provided when creating the batch.

Headers

Parameter	Type	Required	Description
Authorization	String	Required	Mandatory. JWT token in format Bearer eyj0.... For more information about authentication, please refer to Authentication.

Path Parameters

Name	Type	Required	Description
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:

Argentina, Brazil, Mexico and Chile

curl --location \
--request GET '{{api_base_url}}/api/virtual-account-batch/7ff43cc9-4e0f-49c1-a978-b6dc5210fa79/' \
--header 'Authorization: Bearer <your_access_token>'

Response

A successful request returns an HTTP status code 200, along with the updated status of the virtual accounts. 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

Parameter	Type	Description	Possible values	Example
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.
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.
comment	String	Additional information.
csvFormatResponse	String	CSV-formatted string containing the results of the batch process. Each row represents a created account, with columns for internal_id, external_id, and bank_account.

Response Examples

200 - OK

{
    "externalId": "7ff43cc9-4e0f-49c1-a978-b6dc5210fa79",
    "internalId": "e78809df-13cd-4801-8a7d-d07d357a7b64",
    "accountNumber": "484.484.00000011",
    "status": {
        "code": "200",
        "description": "COMPLETED",
        "detail": "Batch Process Virtual Account completed"
    },
    "comment": "The batch process is done - The process started at = 2025-06-19 02:24:50.381 - Total accounts requested = 2 - Total accounts created = 2 - The process finished at = 2025-06-19 02:24:50.894 - ",
    "csvFormatResponse": "internal_id,external_id,bank_account\neb43ee08-7807-490f-a008-1245b6b743ef,1b0ac426-d2ba-4669-880b-f14bfbe48468,646011319800153398\ne0eee942-dcd1-4c08-a834-29cc64747a07,6f555d3f-c970-448e-bc79-1dc75b24c1e0,646011319800153408\n"
}

400 - Bad Request

{
  "timestamp": "2025-01-03T23:11:24.655+00:00",
  "status": 400,
  "error": "Bad Request.",
  "message": "Batch external id not found: bbe17535-607c-4621-9966-13146494cc6511",
  "path": "/virtual-account/batch/bbe17535-607c-4621-9966-13146494cc6511"
}