Check Virtual account

GET {{api_environment_url}}/api/virtual-account/:externalid

Check the creation status of a Virtual Account

Query Parameters

Name	Type	Description
externalId*	String	An ID that is meaningful to you and your system. Must be unique.

200: OK State Completed

{
    "externalId": "1661435667",
    "internalId": "bbcada95-ee39-460f-8e57-b01ca17fa8b5",
    "accountNumber": "484.484.00000011",
    "country": "MEX",
    "currency": "MXN",
    "beneficiary": {
        "type": "INDIVIDUAL",
        "name": "Juan",
        "lastname": "Perez",
        "document": {
            "type": "RFC",
            "id": "LEKF8101111Z5"
        },
        "bank": {
            "account": {
                "number": "646010319800000073"
            }
        }
    },
    "status": {
        "code": "200",
        "description": "COMPLETED",
        "detail": "Virtual account has been created"
    },
    "errors": []
}

Example: Check Virtual Account response

Request

curl --location \
--request GET '{{api_base_url}}/api/virtual-account/1699453091/' \
--header 'Authorization: Bearer {{token}}'

In Progress

{
    "externalId": "1699453091",
    "internalId": "xxxxxx95-ee39-460f-8e57-b01ca17fa8b5",
    "accountNumber": "484.484.00000011",
    "country": "MEX",
    "currency": "MXN",
    "beneficiary": {
        "type": "INDIVIDUAL",
        "name": "FirtName",
        "lastname": "LastName",
        "document": {
            "type": "RFC",
            "id": "LEKF8104019Z5"
        }
    },
    "status": {
        "code": "100",
        "description": "INPROGRESS",
        "detail": "Virtual account in progress"
    },
    "errors": []
}

Completed

{
    "externalId": "1699453091",
    "internalId": "xxxxxx95-ee39-460f-8e57-b01ca17fa8b5",
    "accountNumber": "{{AccountNumber}}",
    "country": "MEX",
    "currency": "MXN",
    "beneficiary": {
        "type": "INDIVIDUAL",
        "name": "FirtName",
        "lastname": "LastName",
        "document": {
            "type": "RFC",
            "id": "LEKF8104014Z5"
        },
        "bank": {
            "account": {
                "number": "646000319800000399"
            }
        }
    },
    "status": {
        "code": "200",
        "description": "COMPLETED",
        "detail": "Virtual account has been created"
    },
    "errors": [],
}

You will get the Bank Account Number when the transaction is in COMPLETED status.