Alias ​​configuration

This configuration will allow you to assign the alias to a virtual account. Please note that this process is applicable only in Brazil

Alias Creation

POST {{api_environment_url}}/api/virtual-account/{{ExternalIdVirtualAccount}}/alias

Configuration Alias of a Virtual Account

Request Body

Name	Type	Description
type*	string	The type of alias to be associated can be 'E' for email or 'P' for phone number.
value*	string	Value indicating the type of alias to be configured—either an email address or a phone number.

Response

200

{
    "externalId": "94b6faee-0b85-4304-915b-e857981b4c07",
    "alias": {
        "type": "E",
        "value": "[e-mail]"
    },
    "status": {
        "code": "100",
        "description": "INPROGRESS",
        "detail": "Alias creation pending confirmation"
    }
}

400

{
    "externalId": "94b6faee-0b85-4304-915b-e857981b4c07",
    "alias": {
        "type": "E",
        "value": "[e-mail]"
    },
    "status": {
        "code": "802",
        "description": "REJECTED",
        "detail": "Alias could not be created"
    }
}

Example: Configuration request

Request

{
"type": "E",
"value": "[e-mail]"
}

Status Ok

{
    "externalId": "94b6faee-0b85-4304-915b-e857981b4c07",
    "alias": {
        "type": "E",
        "value": "[e-mail]"
    },
    "status": {
        "code": "100",
        "description": "INPROGRESS",
        "detail": "Alias creation pending confirmation"
    }
}

Bad Request

{
    "externalId": "94b6faee-0b85-4304-915b-e857981b4c07",
    "alias": {
        "type": "E",
        "value": "[e-mail]"
    },
    "status": {
        "code": "802",
        "description": "REJECTED",
        "detail": "Alias could not be created"
    }
}

Please note that the data entered in the alias field must be valid and accurate. Once the request is submitted, a code will be sent to the email address or mobile phone number, depending on the selected type. This code will expire after 5 minutes and must be provided in a separate service to confirm the alias.

Alias Confirmation

Once the previous action is completed and you have the code, you must execute this confirmation service.

POST {{api_environment_url}}/api/virtual-account/{{ExternalIdVirtualAccount}}/alias/confirm

Body

Name	Type	Description
type*	string	The type of alias to be associated can be 'E' for email or 'P' for phone number.
value*	string	Value indicating the type of alias to be configured—either an email address or a phone number.
confirmationCode*	string	Confirmation code generated when executing the account configuration service

Response

200

{
    "externalId": "94b6faee-0b85-4304-915b-e857981b4c07",
    "alias": {
        "type": "E",
        "value": "[e-mail]",
        "confirmationCode": "221595"
    },
    "status": {
        "code": "100",
        "description": "INPROGRESS",
        "detail": "Alias confirmed"
    }
}

400

{
    "externalId": "94b6faee-0b85-4304-915b-e857981b4c07",
    "alias": {
        "type": "E",
        "value": "[e-mail]"
    },
    "status": {
        "code": "802",
        "description": "REJECTED"
    }
}

Example: Confirmation request

Request

{
"type": "E",
"value": "[e-mail]",
"confirmationCode": "444088"
}

Status Ok

{
    "externalId": "94b6faee-0b85-4304-915b-e857981b4c07",
    "alias": {
        "type": "E",
        "value": "[e-mail]",
        "confirmationCode": "221595"
    },
    "status": {
        "code": "100",
        "description": "INPROGRESS",
        "detail": "Alias confirmed"
    }
}

Bad Request

{
    "externalId": "94b6faee-0b85-4304-915b-e857981b4c07",
    "alias": {
        "type": "E",
        "value": "[e-mail]"
    },
    "status": {
        "code": "802",
        "description": "REJECTED"
    }
}

Resend Token

POST {{api_environment_url}}/api/virtual-account/{{ExternalIdVirtualAccount}}/alias/resendcode

This service allows you to generate a new access token in case the previous token has expired.

Body Request

Name	Type	Description
Type*	string	The type of alias to be associated can be 'E' for email or 'P' for phone number.
Value*	string	The type of alias to be associated can be 'E' for email or 'P' for phone number.

Response

200

{
    "externalId": "94b6faee-0b85-4304-915b-e857981b4c07",
    "alias": {
        "type": "E",
        "value": "[e-mail]"
    },
    "status": {
        "code": "100",
        "description": "INPROGRESS",
        "detail": "Alias creation pending confirmation"
    }
}

400

{
    "externalId": "94b6faee-0b85-4304-915b-e857981b4c07",
    "alias": {
        "type": "E",
        "value": "[e-mail]"
    },
    "status": {
        "code": "802",
        "description": "REJECTED"
    }
}

Request

{
"type": "E",
"value": "[e-mail]"
}

Status Ok

{
    "externalId": "94b6faee-0b85-4304-915b-e857981b4c07",
    "alias": {
        "type": "E",
        "value": "[e-mail]"
    },
    "status": {
        "code": "100",
        "description": "INPROGRESS",
        "detail": "Alias creation pending confirmation"
    }
}

Bad Request

{
    "externalId": "94b6faee-0b85-4304-915b-e857981b4c07",
    "alias": {
        "type": "E",
        "value": "[e-mail]"
    },
    "status": {
        "code": "802",
        "description": "REJECTED"
    }
}