Create Customer

post

https://pg-sandbox.paymaya.com/payments/v1/customers

Creates a customer record that will be used to attach a fund source (i.e card linked to a customer).

For Basic Authentication, use SECRET API KEY. Learn more

The Create Customer endpoint supports two specifications:

Kount Buyer - Use when Kount Fraud Protection is enabled. All fields tagged as required must be provided; others are optional.
Basic Buyer – Use when Kount is NOT enabled. All fields are optional, but at least one valid field must be provided.

Body Params

Create Customer

Contains personal information regarding the buyer/payer of the transaction.

firstName

string

length between 1 and 1000

First name of the payer/buyer.

middleName

string

length between 1 and 1000

Middle name of the payer/buyer.

lastName

string

length between 1 and 1000

Last name of the payer/buyer.

birthday

date

Birthday in ISO 8601 / RFC 3339 full-date format.

customerSince

date

Date in ISO 8601 / RFC 3339 full-date format when payer/buyer registered as a customer as per merchant's records.

sex

string

enum

Biological sex.

Allowed:

contact

object

Contact details like phone and/or email address.

billingAddress

Contains billing information of the payer/buyer. By default, all information are optional (i.e. use Basic Billing Address specification).
However, If the merchant is enabled to use Kount fraud protection, they must use Kount Billing Address specification.

shippingAddress

Contains shipment information including name of the person identified to receive the purchase order. By default, all information are optional (i.e. use Basic Shipping Address specification).
However, If the merchant is enabled to use Kount fraud protection, they must use Kount Shipping Address specification.

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully created customer record.