Create a customer linked to a merchant

curl --request POST \ --url https://api-sandbox.paygood.co/merchants/{merchantId}/customers \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "entityType": "individual", "firstName": "Ahmadou", "lastName": "Diallo", "email": "ahmadou.diallo@example.com", "phone": "+12025550125", "idempotencyKey": "idem_merchant_customer_individual_001" } '

{ "customerId": "<string>", "name": "<string>", "displayName": "<string>", "email": "jsmith@example.com", "createdAt": "2023-11-07T05:31:56Z", "firstName": "<string>", "lastName": "<string>", "organizationName": "<string>", "phone": "<string>" }

Authorizations

Authorization

string

header

required

Merchant API key bearer token. Legacy wire prefixes api_key_ and api_ are also accepted.

Path Parameters

merchantId

string

required

Merchant TypeID (mer_...) for the owner context.

Body

application/json

Create a customer under the merchant scope. Request shape depends on entityType.

Option 1
Option 2

entityType

enum<string>

required

Available options:

individual

firstName

string

required

Individual legal first name.

Minimum string length: 1

lastName

string

required

Individual legal last name.

Minimum string length: 1

string<email>

required

idempotencyKey

string

required

Idempotency key for safe create retries.

Minimum string length: 1

phone

string

Optional customer phone number.

Minimum string length: 1

Response

201 - application/json

customerId

string

required

name

string

required

Minimum string length: 1

displayName

string

required

Minimum string length: 1

string<email>

required

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

entityType

enum<string>

required

Available options:

individual,

organization

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

firstName

string

lastName

string

organizationName

string

phone

string