Sign in

v1

latestOpenAPI 3.1.02026-07-245361280.3 KB

Create unique reference

This service generates unique references for virtual account payments.

post/virtual-accounts

Query parameters

countrystring required

Payment processing country code. ISO 3166-1 alpha-2 code.

payment_method_idstring required

Payment method code chosen to create the virtual account. </br></br>Length: 2.

namestring

User's full name.</br></br>Length: 100.

user_referencestring required

Unique user ID at the merchant side. </br></br>Length: 125.

emailstring required

User’s email address.</br></br>Length: 100.</br>India-compliant length: 64 max for the username (e.g., in gaurav.kumar@example.com, "gaurav.kumar" must not exceed 64 characters).

phonestring required

User’s phone. Mandatory for Wallets in India. </br></br>Length: 20.</br>India-compliant length: 15 max (e.g., +919123456780).

documentstring required

User’s personal identification number.</br></br>To see the document code list per country, go to the Country Reference page.</br></br>Length: 30.

external_referencestring required

External reference / ID.

Response

200

idstring
countrystring
created_datestring
statusstring
status_detailstring
status_codestring
external_referencestring

Example response

{
  "id": "75c7473a-ab86-4e43-bd39-c840268747d3",
  "country": "MX",
  "created_date": "2024-12-26T20:37:20.000+0000",
  "status": "CREATED",
  "status_detail": "The virtual account has been created",
  "status_code": "200",
  "external_reference": "5346523565",
  "virtual_account": {
    "bank_code": "ARCUS",
    "branch_code": "ARCUS",
    "bank_account": "706180323360518000"
  },
  "payer": {
    "name": "Jane Doe",
    "user_reference": "301371669",
    "email": "jdoe@example.com",
    "phone": "+529848774040",
    "document": "99999999999"
  }
}