Request Individual

Only Available for Brazil

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

Request Body

Name
Type
Description

externalId*

string

Mandatory. An ID that is meaningful to you and your system. It must be unique and alphanumeric, no characters allowed.

accountNumber*

string

Your Localpayment account number

country*

string

BRA

currency*

string

BRL

beneficiary*

Object

Party Object

beneficiary.type*

string

Possible values: "COMPANY" or "INDIVIDUAL"

beneficiary.name*

string

Individual / company name

beneficiary.lastname

string

Only for INDIVIDUAL type / Ignored for COMPANY.

beneficiary.document

Object

document.type

string

Document type,CPF for INDIVIDUAL or CNPJ for COMPANY

document.id

string

Identity document id. Usually numbers or combination of numbers and letters (related to the beneficiary's residence).

address

Object

Party Object

address.street

String

Street address

address.number

String

number address

address.city

String

City

address.country

String

Country address

address.state

String

State adress

address.zipcode

String

Address zipcode

{
    "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": []
}

Example: Virtual Account request

{
    "externalId": "{{externalId}}",
    "accountNumber": "{{YourAccountNumber}}",
    "country": "BRA",
    "beneficiary": {
        "document": {
            "id": "documentId",
            "type": "documentType"
        },
        "name": "FirtName",
        "lastname": "LastName",
        "type": "INDIVIDUAL"
    }
}

Last updated