Get Virtual Account Status

Localpayment provides multiple methods to monitor and retrieve the current status of virtual accounts, including individual account checks, batch processing status, and dashboard visualization. This guide outlines the different approaches for tracking virtual account status and managing account lifecycle.

Availability

Virtual Account status monitoring is available in all countries where virtual accounts are supported:

Before You Begin

Ensure you have:

• Valid API credentials (access token).
• Virtual account IDs or batch reference numbers you want to check.

Virtual Account Status Reference

Virtual accounts can have the following statuses throughout their lifecycle:

Retrieve Virtual Account Information

After requesting your virtual account, you'll be able to check its status using any of the following methods:

Method 1: Check Individual Virtual Account Status

Retrieve the current status and details of a specific virtual account using the individual status endpoint.

Example Request

Send a GET request to the individual virtual account status endpoint. Below is an example using curl:

curl --request GET \
     --url https://api.stage.localpayment.com/api/virtual-account/{externalId} \
  --header 'Authorization: Bearer <your_access_token>' \
     --header 'accept: application/json'

Key Request Parameters

The request requires several key objects:

Successful Response

{
  "currency": "MXN",
  "externalId": "a79aabec-16c6-4a84-8abe-be2dcd2e07a1",
  "internalId": "d710312c-8c3f-4b65-8e62-7f83eeba321a",
  "accountNumber": "484.484.00000011",
  "beneficiary": {
    "type": "INDIVIDUAL",
    "name": "John",
    "document": {
      "type": "RFC",
      "id": "EXTF900101NI1"
    },
    "fullName": "John Doe",
    "lastName": "Doe"
  },
  "status": {
    "code": "100",
    "description": "INPROGRESS",
    "detail": "Virtual account in progress"
  },
  "errors": []
}

Key Response Fields

Method 2: Check Batch Virtual Account Status

Monitor the status of virtual accounts created in batch operations, including creation progress and any errors.

Example Request

Send a GET request to the Get Status of Virtual Accounts in Batch endpoint. Below is an example using curl:

curl --request GET \
     --url https://api.stage.localpayment.com/api/virtual-account-batch/{externalId} \
  --header 'Authorization: Bearer <your_access_token>' \
     --header 'accept: application/json'

Key Request Parameters

The request requires several key objects:

Successful Response

{
  "externalId": "ba671d03-b3bc-4312-8841-5c65a67713ca",
  "internalId": "91c0de90-9d70-44a6-b9c6-600f835802b6",
  "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-01-03 22:59:14.355 - Total accounts requested = 12 - Total accounts created = 12 - The process finished at = 2025-01-03 22:59:17.716 - ",
  "csvFormatResponse": "internal_id,external_id,bank_account\ne68208a1-3197-4b1e-82f6-76525a734e56,1111111111-1,646011319800023500\n80dcc234-1010-427b-b256-3fff18325baf,1111111111-2,646011319800023501\nd779c2ab-2505-43b8-874c-fcb97a2e5fb7,1111111111-3,646011319800023502\nafd67163-fd79-4b2c-b288-c4d253bcec57,1111111111-4,646011319800023503\n01e1d1bb-c89c-4d41-849d-bd1d8e5c3785,1111111111-5,646011319800023504\n0ba88114-ae62-407b-9f03-8f863000c163,1111111111-6,646011319800023505\n0184a17a-5c38-4c43-b10a-15079662e518,1111111111-7,646011319800023506\nb80991f5-396d-485a-b480-fdfb8635bef3,1111111111-8,646011319800023507\ncd0f6180-c3ad-4a69-815f-25d6f053aee2,1111111111-9,646011319800023608\n95ea6157-2d17-459c-969a-708ca31cfc13,1111111111-10,646011319800023609\ncf50e4d2-ac34-48f4-a60f-b2ee8b152f6a,1111111111-11,646011319800023610\n70d1f0be-3db0-48fd-8493-b712038ea48e,1111111111-12,646011319800023611\n"
}

Key Response Fields

Method 3: Check Virtual Account Status via Dashboard

For manual monitoring and visual analysis, use the Localpayment Dashboard to view virtual account status.

Dashboard Access

1. Log in to your Localpayment Dashboard
2. Navigate to PayIn > Virtual Accounts > Activity section
3. Use filters to search by:
   • Client: Select the merchant account for which you want to retrieve the information.
   • Country: Choose a specific country or select All to include all available countries.
   • Status: Filter accounts by their current status or select All to view accounts with any status.
   • Date Range: Specify the date range to filter the virtual account activities.
   • Virtual Account Number: You can search directly by the Virtual Account Number (VAN) to quickly locate a specific entry.

Next Steps

After monitoring virtual account status, you may need to perform additional management actions: