v1
latestOpenAPI 3.0.32026-07-2476126451.9 KBv1.1
Create customer
Create customer
post/api/v1.4/customers/
Request body
idstring required
A unique customer identifier, identifier is V4 UUID
type'INDIVIDUAL' | 'COMPANY'
- INDIVIDUAL - Individual
- COMPANY - Company
namestring nullable
first_namestring nullable
Customer First Name
last_namestring nullable
Customer Last Name
emailstring email nullable
Customer Email
phone_numberstring nullable
Customer Phone Number
descriptionstring nullable
{"stackTrail":"components:schemas:Customer:properties:custom_fields","oasType":"schema","type":"unknown","description":"Key value pairs of any additional information you want to save with the payment.","nullable":true}
company_namestring nullable
If the customer is a company, this field is required
tax_idinteger nullable
Customer Tax ID
tax_rateinteger nullable
Customer Tax Rate
addressstring nullable
Customer Address
national_idstring nullable
Customer National ID
contact_person_namestring nullable
If the customer is a company, this field is required
birth_datestring date nullable
Customer Birth Date
walletsobject required
uuidstring uuid
A unique customer identifier, identifier is V4 UUID
last_used_payment_methodstring nullable
last_used_methodstring required
Response
idstring required
A unique customer identifier, identifier is V4 UUID
type'INDIVIDUAL' | 'COMPANY'
- INDIVIDUAL - Individual
- COMPANY - Company
namestring nullable
first_namestring nullable
Customer First Name
last_namestring nullable
Customer Last Name
emailstring email nullable
Customer Email
phone_numberstring nullable
Customer Phone Number
descriptionstring nullable
{"stackTrail":"components:schemas:Customer:properties:custom_fields","oasType":"schema","type":"unknown","description":"Key value pairs of any additional information you want to save with the payment.","nullable":true}
company_namestring nullable
If the customer is a company, this field is required
tax_idinteger nullable
Customer Tax ID
tax_rateinteger nullable
Customer Tax Rate
addressstring nullable
Customer Address
national_idstring nullable
Customer National ID
contact_person_namestring nullable
If the customer is a company, this field is required
birth_datestring date nullable
Customer Birth Date
walletsobject required
uuidstring uuid
A unique customer identifier, identifier is V4 UUID
last_used_payment_methodstring nullable
last_used_methodstring required