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

{
    "currency": "BRL",
    "externalId": "{{externalId}}",
    "internalId": "{{internalId}}",
    "accountNumber": "{{yourAccountNumber}}",
    "beneficiary": {
        "type": "INDIVIDUAL",
        "name": "FirtName",
        "document": {
            "type": "documentType",
            "id": "documentId"
        },
        "bank": {
            "branch": {
                "Code": "0001"
            },
            "account": {
                "number": "{{accountNumber}}",
                "aliases": [
                    {
                        "type": "RandomKeyCode",
                        "value": "dad85dfd-928e-4435-abe0-dc117d70c340"
                    }
                ]
            }
        },
        "fullName": "FirtName LastName",
        "lastName": "LastName"
    },
    "status": {
        "code": "200",
        "description": "COMPLETED",
        "detail": "Virtual account has been Completed"
    },
    "errors": []
}

Example: Check Virtual Account response

Request

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

In Progress

{
    "currency": "BRL",
    "externalId": "{{externalId}}",
    "internalId": "{{InternalId}}",
    "accountNumber": "{{YourAccountNumber}}",
    "beneficiary": {
        "type": "INDIVIDUAL",
        "name": "FirtName",
        "document": {
            "type": "documentType",
            "id": "documentId"
        },
        "fullName": "FirtName LastName",
        "lastName": "LastName"
    },
    "status": {
        "code": "100",
        "description": "INPROGRESS",
        "detail": "Virtual account has been created"
    },
    "errors": []
}

Completed

{
    "currency": "BRL",
    "externalId": "{{externalId}}",
    "internalId": "{{internalId}}",
    "accountNumber": "{{yourAccountNumber}}",
    "beneficiary": {
        "type": "INDIVIDUAL",
        "name": "FirtName",
        "document": {
            "type": "documentType",
            "id": "documentId"
        },
        "bank": {
            "branch": {
                "Code": "0001"
            },
            "account": {
                "number": "{{accountNumber}}",
                "aliases": [
                    {
                        "type": "RandomKeyCode",
                        "value": "dad85dfd-928e-4435-abe0-dc117d70c340"
                    }
                ]
            }
        },
        "fullName": "FirtName LastName",
        "lastName": "LastName"
    },
    "status": {
        "code": "200",
        "description": "COMPLETED",
        "detail": "Virtual account has been Completed"
    },
    "errors": []
}

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