Create customer

POST

api

customers

Create customer

curl --request POST \
  --url https://pay-api.pagoramp.com/api/v1/customers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "[email protected]",
  "firstname": "John",
  "lastname": "Doe",
  "businessName": "Acme Ltd",
  "phone": "+2348012345678",
  "country": "NG",
  "externalReference": "cust_1001",
  "address": {
    "line1": "12 Marina Road",
    "line2": "<string>",
    "city": "Lagos",
    "state": "Lagos",
    "postalCode": "100001",
    "country": "NG"
  },
  "dateOfBirth": "1990-06-15",
  "nationality": "NG",
  "occupation": "<string>",
  "registrationNumber": "BN123456789",
  "owners": [
    {
      "firstname": "Jane",
      "lastname": "Roe",
      "ownershipPercent": 60,
      "dateOfBirth": "1985-04-12",
      "nationality": "CA"
    }
  ],
  "documents": [
    {
      "type": "incorporation",
      "url": "https://files.example.com/acme-incorporation.pdf"
    }
  ],
  "metadata": {
    "plan": "pro"
  },
  "type": "individual"
}
'

import requests

url = "https://pay-api.pagoramp.com/api/v1/customers"

payload = {
    "email": "[email protected]",
    "firstname": "John",
    "lastname": "Doe",
    "businessName": "Acme Ltd",
    "phone": "+2348012345678",
    "country": "NG",
    "externalReference": "cust_1001",
    "address": {
        "line1": "12 Marina Road",
        "line2": "<string>",
        "city": "Lagos",
        "state": "Lagos",
        "postalCode": "100001",
        "country": "NG"
    },
    "dateOfBirth": "1990-06-15",
    "nationality": "NG",
    "occupation": "<string>",
    "registrationNumber": "BN123456789",
    "owners": [
        {
            "firstname": "Jane",
            "lastname": "Roe",
            "ownershipPercent": 60,
            "dateOfBirth": "1985-04-12",
            "nationality": "CA"
        }
    ],
    "documents": [
        {
            "type": "incorporation",
            "url": "https://files.example.com/acme-incorporation.pdf"
        }
    ],
    "metadata": { "plan": "pro" },
    "type": "individual"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '[email protected]',
    firstname: 'John',
    lastname: 'Doe',
    businessName: 'Acme Ltd',
    phone: '+2348012345678',
    country: 'NG',
    externalReference: 'cust_1001',
    address: {
      line1: '12 Marina Road',
      line2: '<string>',
      city: 'Lagos',
      state: 'Lagos',
      postalCode: '100001',
      country: 'NG'
    },
    dateOfBirth: '1990-06-15',
    nationality: 'NG',
    occupation: '<string>',
    registrationNumber: 'BN123456789',
    owners: [
      {
        firstname: 'Jane',
        lastname: 'Roe',
        ownershipPercent: 60,
        dateOfBirth: '1985-04-12',
        nationality: 'CA'
      }
    ],
    documents: [
      {type: 'incorporation', url: 'https://files.example.com/acme-incorporation.pdf'}
    ],
    metadata: {plan: 'pro'},
    type: 'individual'
  })
};

fetch('https://pay-api.pagoramp.com/api/v1/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pay-api.pagoramp.com/api/v1/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '[email protected]',
    'firstname' => 'John',
    'lastname' => 'Doe',
    'businessName' => 'Acme Ltd',
    'phone' => '+2348012345678',
    'country' => 'NG',
    'externalReference' => 'cust_1001',
    'address' => [
        'line1' => '12 Marina Road',
        'line2' => '<string>',
        'city' => 'Lagos',
        'state' => 'Lagos',
        'postalCode' => '100001',
        'country' => 'NG'
    ],
    'dateOfBirth' => '1990-06-15',
    'nationality' => 'NG',
    'occupation' => '<string>',
    'registrationNumber' => 'BN123456789',
    'owners' => [
        [
                'firstname' => 'Jane',
                'lastname' => 'Roe',
                'ownershipPercent' => 60,
                'dateOfBirth' => '1985-04-12',
                'nationality' => 'CA'
        ]
    ],
    'documents' => [
        [
                'type' => 'incorporation',
                'url' => 'https://files.example.com/acme-incorporation.pdf'
        ]
    ],
    'metadata' => [
        'plan' => 'pro'
    ],
    'type' => 'individual'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://pay-api.pagoramp.com/api/v1/customers"

	payload := strings.NewReader("{\n  \"email\": \"[email protected]\",\n  \"firstname\": \"John\",\n  \"lastname\": \"Doe\",\n  \"businessName\": \"Acme Ltd\",\n  \"phone\": \"+2348012345678\",\n  \"country\": \"NG\",\n  \"externalReference\": \"cust_1001\",\n  \"address\": {\n    \"line1\": \"12 Marina Road\",\n    \"line2\": \"<string>\",\n    \"city\": \"Lagos\",\n    \"state\": \"Lagos\",\n    \"postalCode\": \"100001\",\n    \"country\": \"NG\"\n  },\n  \"dateOfBirth\": \"1990-06-15\",\n  \"nationality\": \"NG\",\n  \"occupation\": \"<string>\",\n  \"registrationNumber\": \"BN123456789\",\n  \"owners\": [\n    {\n      \"firstname\": \"Jane\",\n      \"lastname\": \"Roe\",\n      \"ownershipPercent\": 60,\n      \"dateOfBirth\": \"1985-04-12\",\n      \"nationality\": \"CA\"\n    }\n  ],\n  \"documents\": [\n    {\n      \"type\": \"incorporation\",\n      \"url\": \"https://files.example.com/acme-incorporation.pdf\"\n    }\n  ],\n  \"metadata\": {\n    \"plan\": \"pro\"\n  },\n  \"type\": \"individual\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://pay-api.pagoramp.com/api/v1/customers")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[email protected]\",\n  \"firstname\": \"John\",\n  \"lastname\": \"Doe\",\n  \"businessName\": \"Acme Ltd\",\n  \"phone\": \"+2348012345678\",\n  \"country\": \"NG\",\n  \"externalReference\": \"cust_1001\",\n  \"address\": {\n    \"line1\": \"12 Marina Road\",\n    \"line2\": \"<string>\",\n    \"city\": \"Lagos\",\n    \"state\": \"Lagos\",\n    \"postalCode\": \"100001\",\n    \"country\": \"NG\"\n  },\n  \"dateOfBirth\": \"1990-06-15\",\n  \"nationality\": \"NG\",\n  \"occupation\": \"<string>\",\n  \"registrationNumber\": \"BN123456789\",\n  \"owners\": [\n    {\n      \"firstname\": \"Jane\",\n      \"lastname\": \"Roe\",\n      \"ownershipPercent\": 60,\n      \"dateOfBirth\": \"1985-04-12\",\n      \"nationality\": \"CA\"\n    }\n  ],\n  \"documents\": [\n    {\n      \"type\": \"incorporation\",\n      \"url\": \"https://files.example.com/acme-incorporation.pdf\"\n    }\n  ],\n  \"metadata\": {\n    \"plan\": \"pro\"\n  },\n  \"type\": \"individual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pay-api.pagoramp.com/api/v1/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"[email protected]\",\n  \"firstname\": \"John\",\n  \"lastname\": \"Doe\",\n  \"businessName\": \"Acme Ltd\",\n  \"phone\": \"+2348012345678\",\n  \"country\": \"NG\",\n  \"externalReference\": \"cust_1001\",\n  \"address\": {\n    \"line1\": \"12 Marina Road\",\n    \"line2\": \"<string>\",\n    \"city\": \"Lagos\",\n    \"state\": \"Lagos\",\n    \"postalCode\": \"100001\",\n    \"country\": \"NG\"\n  },\n  \"dateOfBirth\": \"1990-06-15\",\n  \"nationality\": \"NG\",\n  \"occupation\": \"<string>\",\n  \"registrationNumber\": \"BN123456789\",\n  \"owners\": [\n    {\n      \"firstname\": \"Jane\",\n      \"lastname\": \"Roe\",\n      \"ownershipPercent\": 60,\n      \"dateOfBirth\": \"1985-04-12\",\n      \"nationality\": \"CA\"\n    }\n  ],\n  \"documents\": [\n    {\n      \"type\": \"incorporation\",\n      \"url\": \"https://files.example.com/acme-incorporation.pdf\"\n    }\n  ],\n  \"metadata\": {\n    \"plan\": \"pro\"\n  },\n  \"type\": \"individual\"\n}"

response = http.request(request)
puts response.read_body

Authorizations

x-api-key

string

header

required

Body

application/json

string

required

Example:

"[email protected]"

firstname

string

Required for individuals.

Example:

"John"

lastname

string

Required for individuals.

Example:

"Doe"

businessName

string

Required for businesses.

Example:

"Acme Ltd"

phone

string

Must start with + and the country code. Spaces, dashes and brackets are removed.

Example:

"+2348012345678"

country

string

Example:

"NG"

externalReference

string

Your own id for this customer. Unique per merchant.

Example:

"cust_1001"

identification

object

Hide child attributes

identification.type

string

required

For example BVN, NIN, passport, national_id, tax_id.

Example:

"BVN"

identification.number

string

required

Stored encrypted and never returned; only the last four characters come back.

Example:

"12345678901"

address

object

Hide child attributes

address.line1

string

Example:

"12 Marina Road"

address.line2

string

address.city

string

Example:

"Lagos"

address.state

string

Example:

"Lagos"

address.postalCode

string

Example:

"100001"

address.country

string

Example:

"NG"

dateOfBirth

string

Individuals.

Example:

"1990-06-15"

nationality

string

Individuals.

Example:

"NG"

occupation

string

Individuals.

registrationNumber

string

Businesses.

Example:

"BN123456789"

owners

object[]

Businesses: owners and directors.

Hide child attributes

owners.firstname

string

required

Example:

"Jane"

owners.lastname

string

required

Example:

"Roe"

owners.ownershipPercent

number

Example:

60

owners.dateOfBirth

string

Example:

"1985-04-12"

owners.nationality

string

Example:

"CA"

documents

object[]

Hide child attributes

documents.type

string

required

For example id_document, utility_bill, incorporation, proof_of_address.

Example:

"incorporation"

documents.url

string

required

An https link the provider can open.

Example:

"https://files.example.com/acme-incorporation.pdf"

metadata

object

Returned unchanged. 4000 characters of JSON at most.

Example:

{ "plan": "pro" }

type

enum<string>

default:individual

Defaults to individual when omitted.

Available options:

individual,

business

Response

Create customer

curl --request POST \
  --url https://pay-api.pagoramp.com/api/v1/customers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "[email protected]",
  "firstname": "John",
  "lastname": "Doe",
  "businessName": "Acme Ltd",
  "phone": "+2348012345678",
  "country": "NG",
  "externalReference": "cust_1001",
  "address": {
    "line1": "12 Marina Road",
    "line2": "<string>",
    "city": "Lagos",
    "state": "Lagos",
    "postalCode": "100001",
    "country": "NG"
  },
  "dateOfBirth": "1990-06-15",
  "nationality": "NG",
  "occupation": "<string>",
  "registrationNumber": "BN123456789",
  "owners": [
    {
      "firstname": "Jane",
      "lastname": "Roe",
      "ownershipPercent": 60,
      "dateOfBirth": "1985-04-12",
      "nationality": "CA"
    }
  ],
  "documents": [
    {
      "type": "incorporation",
      "url": "https://files.example.com/acme-incorporation.pdf"
    }
  ],
  "metadata": {
    "plan": "pro"
  },
  "type": "individual"
}
'

import requests

url = "https://pay-api.pagoramp.com/api/v1/customers"

payload = {
    "email": "[email protected]",
    "firstname": "John",
    "lastname": "Doe",
    "businessName": "Acme Ltd",
    "phone": "+2348012345678",
    "country": "NG",
    "externalReference": "cust_1001",
    "address": {
        "line1": "12 Marina Road",
        "line2": "<string>",
        "city": "Lagos",
        "state": "Lagos",
        "postalCode": "100001",
        "country": "NG"
    },
    "dateOfBirth": "1990-06-15",
    "nationality": "NG",
    "occupation": "<string>",
    "registrationNumber": "BN123456789",
    "owners": [
        {
            "firstname": "Jane",
            "lastname": "Roe",
            "ownershipPercent": 60,
            "dateOfBirth": "1985-04-12",
            "nationality": "CA"
        }
    ],
    "documents": [
        {
            "type": "incorporation",
            "url": "https://files.example.com/acme-incorporation.pdf"
        }
    ],
    "metadata": { "plan": "pro" },
    "type": "individual"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '[email protected]',
    firstname: 'John',
    lastname: 'Doe',
    businessName: 'Acme Ltd',
    phone: '+2348012345678',
    country: 'NG',
    externalReference: 'cust_1001',
    address: {
      line1: '12 Marina Road',
      line2: '<string>',
      city: 'Lagos',
      state: 'Lagos',
      postalCode: '100001',
      country: 'NG'
    },
    dateOfBirth: '1990-06-15',
    nationality: 'NG',
    occupation: '<string>',
    registrationNumber: 'BN123456789',
    owners: [
      {
        firstname: 'Jane',
        lastname: 'Roe',
        ownershipPercent: 60,
        dateOfBirth: '1985-04-12',
        nationality: 'CA'
      }
    ],
    documents: [
      {type: 'incorporation', url: 'https://files.example.com/acme-incorporation.pdf'}
    ],
    metadata: {plan: 'pro'},
    type: 'individual'
  })
};

fetch('https://pay-api.pagoramp.com/api/v1/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pay-api.pagoramp.com/api/v1/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '[email protected]',
    'firstname' => 'John',
    'lastname' => 'Doe',
    'businessName' => 'Acme Ltd',
    'phone' => '+2348012345678',
    'country' => 'NG',
    'externalReference' => 'cust_1001',
    'address' => [
        'line1' => '12 Marina Road',
        'line2' => '<string>',
        'city' => 'Lagos',
        'state' => 'Lagos',
        'postalCode' => '100001',
        'country' => 'NG'
    ],
    'dateOfBirth' => '1990-06-15',
    'nationality' => 'NG',
    'occupation' => '<string>',
    'registrationNumber' => 'BN123456789',
    'owners' => [
        [
                'firstname' => 'Jane',
                'lastname' => 'Roe',
                'ownershipPercent' => 60,
                'dateOfBirth' => '1985-04-12',
                'nationality' => 'CA'
        ]
    ],
    'documents' => [
        [
                'type' => 'incorporation',
                'url' => 'https://files.example.com/acme-incorporation.pdf'
        ]
    ],
    'metadata' => [
        'plan' => 'pro'
    ],
    'type' => 'individual'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://pay-api.pagoramp.com/api/v1/customers"

	payload := strings.NewReader("{\n  \"email\": \"[email protected]\",\n  \"firstname\": \"John\",\n  \"lastname\": \"Doe\",\n  \"businessName\": \"Acme Ltd\",\n  \"phone\": \"+2348012345678\",\n  \"country\": \"NG\",\n  \"externalReference\": \"cust_1001\",\n  \"address\": {\n    \"line1\": \"12 Marina Road\",\n    \"line2\": \"<string>\",\n    \"city\": \"Lagos\",\n    \"state\": \"Lagos\",\n    \"postalCode\": \"100001\",\n    \"country\": \"NG\"\n  },\n  \"dateOfBirth\": \"1990-06-15\",\n  \"nationality\": \"NG\",\n  \"occupation\": \"<string>\",\n  \"registrationNumber\": \"BN123456789\",\n  \"owners\": [\n    {\n      \"firstname\": \"Jane\",\n      \"lastname\": \"Roe\",\n      \"ownershipPercent\": 60,\n      \"dateOfBirth\": \"1985-04-12\",\n      \"nationality\": \"CA\"\n    }\n  ],\n  \"documents\": [\n    {\n      \"type\": \"incorporation\",\n      \"url\": \"https://files.example.com/acme-incorporation.pdf\"\n    }\n  ],\n  \"metadata\": {\n    \"plan\": \"pro\"\n  },\n  \"type\": \"individual\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://pay-api.pagoramp.com/api/v1/customers")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[email protected]\",\n  \"firstname\": \"John\",\n  \"lastname\": \"Doe\",\n  \"businessName\": \"Acme Ltd\",\n  \"phone\": \"+2348012345678\",\n  \"country\": \"NG\",\n  \"externalReference\": \"cust_1001\",\n  \"address\": {\n    \"line1\": \"12 Marina Road\",\n    \"line2\": \"<string>\",\n    \"city\": \"Lagos\",\n    \"state\": \"Lagos\",\n    \"postalCode\": \"100001\",\n    \"country\": \"NG\"\n  },\n  \"dateOfBirth\": \"1990-06-15\",\n  \"nationality\": \"NG\",\n  \"occupation\": \"<string>\",\n  \"registrationNumber\": \"BN123456789\",\n  \"owners\": [\n    {\n      \"firstname\": \"Jane\",\n      \"lastname\": \"Roe\",\n      \"ownershipPercent\": 60,\n      \"dateOfBirth\": \"1985-04-12\",\n      \"nationality\": \"CA\"\n    }\n  ],\n  \"documents\": [\n    {\n      \"type\": \"incorporation\",\n      \"url\": \"https://files.example.com/acme-incorporation.pdf\"\n    }\n  ],\n  \"metadata\": {\n    \"plan\": \"pro\"\n  },\n  \"type\": \"individual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pay-api.pagoramp.com/api/v1/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"[email protected]\",\n  \"firstname\": \"John\",\n  \"lastname\": \"Doe\",\n  \"businessName\": \"Acme Ltd\",\n  \"phone\": \"+2348012345678\",\n  \"country\": \"NG\",\n  \"externalReference\": \"cust_1001\",\n  \"address\": {\n    \"line1\": \"12 Marina Road\",\n    \"line2\": \"<string>\",\n    \"city\": \"Lagos\",\n    \"state\": \"Lagos\",\n    \"postalCode\": \"100001\",\n    \"country\": \"NG\"\n  },\n  \"dateOfBirth\": \"1990-06-15\",\n  \"nationality\": \"NG\",\n  \"occupation\": \"<string>\",\n  \"registrationNumber\": \"BN123456789\",\n  \"owners\": [\n    {\n      \"firstname\": \"Jane\",\n      \"lastname\": \"Roe\",\n      \"ownershipPercent\": 60,\n      \"dateOfBirth\": \"1985-04-12\",\n      \"nationality\": \"CA\"\n    }\n  ],\n  \"documents\": [\n    {\n      \"type\": \"incorporation\",\n      \"url\": \"https://files.example.com/acme-incorporation.pdf\"\n    }\n  ],\n  \"metadata\": {\n    \"plan\": \"pro\"\n  },\n  \"type\": \"individual\"\n}"

response = http.request(request)
puts response.read_body

Checkout

Misc

Charges

Customers

Virtual Accounts

Authorizations

Body

Response