Enable or Disable Virtual Account

To temporarily avoid receiving payments on a Virtual Account you can disable it. While the account is disabled, the receipt of payments on it will be rejected.

This functionality is only available in Mexico

PUT {{api_environment_url}}/api/virtual-account/:externalid/activation/:status

Query Parameters

Name	Type	Description
externalId*	String
status*	String	enable or disable

Example: Disable Virtual Account

Request

curl --location \
--request PUT '{{api_base_url}}/api/virtual-account/a17998fc/activation/disable' \
--header 'Authorization: Bearer {{token}}'

Disabled

{
    "currency": "MXN",
    "externalId": "a17998fc",
    "internalId": "901fa9fc-91c5-48ee-ace2-a9074d451d51",
    "accountNumber": "484.484.00000001",
    "beneficiary": {
        "type": "INDIVIDUAL",
        "name": "Matias",
        "lastname": "Ariel Mancino",
        "document": {
            "type": "RFC",
            "id": "MAMA831224NA1"
        },
        "bank": {
            "account": {
                "number": "646010319800000044"
            }
        },
        "fullName": "Matias Ariel Mancino"
    },
    "status": {
        "code": "300",
        "description": "DISABLED",
        "detail": "Virtual account disabled"
    },
    "errors": []
}

Example: Enable Virtual Account

Request

curl --location \
--request PUT '{{api_base_url}}/api/virtual-account/a17998fc/activation/enable' \
--header 'Authorization: Bearer {{token}}'

Enabled

{
    "currency": "MXN",
    "externalId": "a17998fc",
    "internalId": "901fa9fc-91c5-48ee-ace2-a9074d451d51",
    "accountNumber": "484.484.00000001",
    "beneficiary": {
        "type": "INDIVIDUAL",
        "name": "Matias",
        "lastname": "Ariel Mancino",
        "document": {
            "type": "RFC",
            "id": "MAMA831224NA1"
        },
        "bank": {
            "account": {
                "number": "646010319800000044"
            }
        },
        "fullName": "Matias Ariel Mancino"
    },
    "status": {
        "code": "200",
        "description": "COMPLETED",
        "detail": "Virtual account has been created"
    },
    "errors": []
}