Create Nigeria Counterparty

This endpoint creates a counterparty for Nigeria.

Authorization:

bearer

HTTP: bearer

HTTP Authorization Scheme: bearer

Headers:
  Authorization: APIKey {YOUR_API_KEY}

Endpoint

POST

/api/v2/banking/counterparties/ng

Request Body Sample

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "reference": "NG-VENDOR-001",
  "counterpartyName": "Adebayo Okonkwo",
  "address": {
    "address1": "15 Broad Street",
    "address2": "Suite 200",
    "city": "Lagos",
    "state": "LA",
    "postalCode": "100001",
    "country": "NG"
  },
  "accountNumber": "0123456789",
  "bankCode": "058",
  "accountType": "bank",
  "type": "individual",
  "dateOfBirth": "1990/01/15",
  "email": "adebayo@example.com",
  "phone": "+2348012345678"
}

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.
accountNumber	string	Required. Nigeria bank account number.
bankCode	string	Required. Nigeria bank code.
accountType	string	Required. Account type. Values: bank, momo.
type	string	Optional. Counterparty type. Values: individual, business.
dateOfBirth	string	Optional. Date of birth in YYYY/MM/DD format.
email	string	Optional. Email address.
phone	string	Optional. Phone number in E.164 format.

Response Sample

{
  "id": "00000000-0000-0000-0000-000000000000",
  "accountId": "00000000-0000-0000-0000-000000000000",
  "reference": "NG-VENDOR-001",
  "currency": "NGN",
  "counterpartyName": "Adebayo Okonkwo",
  "address": {
    "address1": "15 Broad Street",
    "address2": "Suite 200",
    "city": "Lagos",
    "state": "LA",
    "postalCode": "100001",
    "country": "NG"
  },
  "accountNumber": "0123456789",
  "bankCode": "058",
  "accountType": "bank",
  "type": "individual",
  "dateOfBirth": "1990/01/15",
  "email": "adebayo@example.com",
  "phone": "+2348012345678",
  "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!