Create Mexico Counterparty

This endpoint creates a counterparty for Mexico with CLABE, debit card, or phone number protocols.

Authorization:

bearer

HTTP: bearer

HTTP Authorization Scheme: bearer

Headers:
  Authorization: APIKey {YOUR_API_KEY}

Endpoint

POST

/api/v2/banking/counterparties/mx

Request Body Sample

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "reference": "MX-VENDOR-001",
  "counterpartyName": "Juan Perez",
  "address": {
    "address1": "Calle Principal 123",
    "address2": "Col. Centro",
    "city": "Ciudad de Mexico",
    "state": "CDMX",
    "postalCode": "06600",
    "country": "MX"
  },
  "protocol": "clabe",
  "clabe": "012345678901234567",
  "institutionCode": "40002",
  "type": "individual",
  "bankAddress": {
    "address1": "Paseo de la Reforma 505",
    "city": "Ciudad de Mexico",
    "state": "CDMX",
    "postalCode": "06500",
    "country": "MX"
  }
}

Request Body Schema

Field	Type	Description
accountId	string (uuid)	Required. The account ID to associate with this counterparty.
reference	string	Required. A unique user-defined reference. Min 1, max 255 characters.
counterpartyName	string	Required. Counterparty name. Min 2, max 255 characters.
address	object	Required. Counterparty's address.
protocol	string	Required. Payment protocol. Values: clabe, debitcard, phonenum.
clabe	string	Required. CLABE number. 10-20 characters.
institutionCode	string	Optional. Institution code. 5 characters.
type	string	Optional. Counterparty type. Values: individual, business.
bankAddress	object	Required. Bank's address. Same schema as address.

Response Sample

{
  "id": "00000000-0000-0000-0000-000000000000",
  "accountId": "00000000-0000-0000-0000-000000000000",
  "reference": "MX-VENDOR-001",
  "currency": "MXN",
  "counterpartyName": "Juan Perez",
  "address": {
    "address1": "Calle Principal 123",
    "address2": "Col. Centro",
    "city": "Ciudad de Mexico",
    "state": "CDMX",
    "postalCode": "06600",
    "country": "MX"
  },
  "protocol": "clabe",
  "clabe": "012345678901234567",
  "institutionCode": "40002",
  "type": "individual",
  "bankAddress": {
    "address1": "Paseo de la Reforma 505",
    "city": "Ciudad de Mexico",
    "state": "CDMX",
    "postalCode": "06500",
    "country": "MX"
  },
  "status": "active",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-01T00:00:00Z"
}

Support and Resources

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

• Instagram: BlockWyre Instagram
• Twitter: BlockWyre Twitter
• Facebook: BlockWyre Facebook
• LinkedIn: BlockWyre LinkedIn

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!