Skip to main content
POST
Create Or Update A Customer

Authorizations

Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

X-TenantID
string
header
required

live or test

Idempotency-Key
string
header
required

A unique value that prevents duplicate processing when retrying the same request.

Scopes

Payaza {{Public API Key In Base64}}
ApiKeyAuth
test or live
TenantID
A unique value that prevents duplicate processing when retrying the same request.
IdempotencyKey

Body

application/json
customer_reference
string
required

Merchant's unique reference for the customer. Used for retrieving and updating the customer.

Example:

"account_001"

type
string
required

Customer type. Supported values: "individual", "business".

Example:

"individual"

email
string<email>
required

The customer's email address.

Example:

"johndoe@company.com"

phone
string
required

The customer's phone number in E.164 format, e.g. +2348012345679..

Example:

"+2348012345679"

country_code
string
required

The customer's country code in ISO 3166-1 Alpha-2 format, e.g. NG.

Example:

"NG"

address
object
required

The customer's residential or operating address. See Address Parameters below.

identifications
object[]
required

The customer identification records

documents
object[]
required

A list of uploaded document links for KYC verification.

individual
object

The individual customer's details.

account
string[]

A list of currencies for the accounts to be created.

Response

Initiate Payment Successful Response

The response is of type any.