Create Colombia Counterparty

This endpoint creates a counterparty for Colombia.

Authorization:

bearer

HTTP: bearer

HTTP Authorization Scheme: bearer

Headers:
  Authorization: APIKey {YOUR_API_KEY}

Endpoint

POST

/api/v2/banking/counterparties/co

Request Body Sample

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "reference": "CO-VENDOR-001",
  "counterpartyName": "Carlos Rodriguez",
  "address": {
    "address1": "Carrera 7 No. 71-52",
    "address2": "Oficina 502",
    "city": "Bogota",
    "state": "DC",
    "postalCode": "110231",
    "country": "CO"
  },
  "bankAccount": "12345678901234",
  "bankCode": "1007",
  "accountType": "savings",
  "documentId": "1234567890",
  "documentType": "CC",
  "email": "carlos@example.com",
  "type": "individual",
  "bankAddress": {
    "address1": "Calle 67 No. 7-35",
    "city": "Bogota",
    "state": "DC",
    "postalCode": "110231",
    "country": "CO"
  }
}

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.
bankAccount	string	Required. Bank account number. 3-18 characters.
bankCode	string	Required. Bank code.
accountType	string	Required. Account type. Values: checking, savings.
documentId	string	Required. Document ID number.
documentType	string	Required. Document type. Values: CC, NIT, CE, PASS, PEP.
email	string	Required. Email address.
type	string	Optional. Counterparty type. Values: individual, business.
bankAddress	object	Required. Bank's address. Same schema as address.

Colombia Document Types

Value	Description
CC	Cedula de Ciudadania
CE	Cedula de Extranjeria
NIT	Numero de Identificacion Tributaria
PASS	Passport
PEP	Permiso Especial de Permanencia

Response Sample

{
  "id": "00000000-0000-0000-0000-000000000000",
  "accountId": "00000000-0000-0000-0000-000000000000",
  "reference": "CO-VENDOR-001",
  "currency": "COP",
  "counterpartyName": "Carlos Rodriguez",
  "address": {
    "address1": "Carrera 7 No. 71-52",
    "address2": "Oficina 502",
    "city": "Bogota",
    "state": "DC",
    "postalCode": "110231",
    "country": "CO"
  },
  "bankAccount": "12345678901234",
  "bankCode": "1007",
  "accountType": "savings",
  "documentId": "1234567890",
  "documentType": "CC",
  "email": "carlos@example.com",
  "type": "individual",
  "bankAddress": {
    "address1": "Calle 67 No. 7-35",
    "city": "Bogota",
    "state": "DC",
    "postalCode": "110231",
    "country": "CO"
  },
  "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!