Request Individual

Only Available for Mexico

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

Request Body

Name	Type	Description
externalId*	string	An ID that is meaningful to you and your system. Must be unique.
accountNumber*	string	Your Localpayment account number
country*	string	Country Codes
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 (related to the beneficiary's residence, could be Mexican resident or non Mexican resident)
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

200: OK

{
    "externalId": "{{externalId}}",
    "internalId": "{{internalId}}",
    "accountNumber": "{{YourAccountNumber}}",
    "country": "MEX",
    "currency": "MXN",
    "beneficiary": {
        "type": "INDIVIDUAL",
        "name": "{{name}}",
        "lastname": "{{lastname}}",
        "document": {
            "type": "RFC",
            "id": "LEKF8104019Z5"
         } 
     },
         
    "status": {
        "code": "100",
        "description": "INPROGRESS",
        "detail": "Virtual account in progress"
    },
    "errors": []
}

Example: Virtual Account request

Request

{
  "externalId": "{{externalId}}",
  "accountNumber": "{{YourAccountNumber}}",
  "country": "MEX",
  "beneficiary": {
    "document": {
      "id": "LEKF8111119Z5",
      "type": "RFC"
    },
    "name": "BeneficiaryName",
    "lastname": "BeneficiaryLastname",
    "type": "INDIVIDUAL"
  },
  "address": {
    "city": "City",
    "state": "State",
    "zipcode": "zipcode",
    "street": "street",
    "number": "number",
    "country": "country"
  }
}'

Status Ok

{
  "externalId": "{{externalId}}",
  "internalId": "{{internalId}}",
  "accountNumber": "{{YourAccountNumber}}",
  "country": "MEX",
  "currency": "MXN",
  "beneficiary": {
    "type": "INDIVIDUAL",
    "name": "BeneficiaryName",
    "lastname": "BeneficiaryLastname",
    "document": {
      "type": "RFC",
      "id": "LEKF8104019Z5"
    }
  },
  "status": {
    "code": "100",
    "description": "INPROGRESS",
    "detail": "Virtual account in progress"
  },
  "errors": []
}

Bad Request

{
  "externalId": "{{externalId}}",
  "internalId": "{{internalId}}",
  "status": {
    "code": "501",
    "description": "REJECTED",
    "detail": "Country not found"
  },
  "errors": [
    {
      "code": "501",
      "detail": "Country not found"
    },
    {
      "code": "501",
      "detail": "Country not found"
    }
  ]
}