QorePay logo
QorePay logo

Create a new client

POST

https://gate.qorepay.com/api/v1/clients/

Client is a record of a single customer of your business. Create one for each of your clients; you will be able to issue invoices/subscriptions for them later easily using/billing_templates/ API.

Each BillingTemplateClient (there can be many attached to a single BillingTemplate) will bind a single Client to a BillingTemplate.

HEADER PARAMS

  • authorization

    String

    required

    Set value to BEARER SECRET_KEY

  • content-type

    String

    required

    Set value to JSON

REQUEST BODY

  • email

    string

    required

    The client's email address

  • phone

    string

    The client's phone number in the country_code number format. Eg. +2349010010010

  • full_name

    string

    Client's full name

  • personal_code

    string

    Personal identification code of client

  • street_address

    string

    Street house number and flat address where applicable

  • country

    string

    Country code in the ISO 3166-1 alpha-2 format (e.g. NG)

  • city

    string

    City name e.g Yaba

  • zip_code

    string

    ZIP or postal code

  • state

    string

    state code

  • shipping_street_address

    string

    Street house number and flat address where applicable

  • shipping_country

    string

    Shipping Country code in the ISO 3166-1 alpha-2 format (e.g. NG)

  • shipping_city

    string

    Shipping City name e.g Yaba

  • shipping_zip_code

    string

    Shipping zip or postal code

  • shipping_state

    string

    Shipping state code

  • legal_name

    string

    Legal name of company

  • brand_name

    string

    Company brand name

  • registration_number

    string

    Registration number of company

  • tax_number

    string

    Company's Tax Identifaction Number

RESPONSES

  • 201

    OK

  • 400

    Invalid data submitted or request processing error

Query

Body


const options = {
  method: 'POST',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json'
  },
  body: JSON.stringify({
    {
      "bank_account": "string",
      "bank_code": "string",
      "email": "[email protected]",
      "phone": "+23445643564564",
      "full_name": "string",
      "personal_code": "string",
      "street_address": "string",
      "country": "NG",
      "city": "string",
      "zip_code": "string",
      "state": "string",
      "shipping_street_address": "string",
      "shipping_country": "st",
      "shipping_city": "string",
      "shipping_zip_code": "string",
      "shipping_state": "string", 
      "legal_name": "string",
      "brand_name": "string",
      "registration_number": "string",
      "tax_number": "string"
    }
  })
};

fetch('https://gate.qorepay.com/api/v1/clients/', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Sample Response

JSON


{
  "type": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_on": 1619740800,
  "updated_on": 1619740800,
  "bank_account": "string",
  "bank_code": "string",
  "email": "[email protected]",
  "phone": "+44 45643564564",
  "full_name": "string",
  "personal_code": "string",
  "street_address": "string",
  "country": "st",
  "city": "string",
  "zip_code": "string",
  "state": "string",
  "shipping_street_address": "string",
  "shipping_country": "st",
  "shipping_city": "string",
  "shipping_zip_code": "string",
  "shipping_state": "string",
  "cc": [
    "[email protected]"
  ],
  "bcc": [
    "[email protected]"
  ],
  "legal_name": "string",
  "brand_name": "string",
  "registration_number": "string",
  "tax_number": "string"
}