post http://{{url}}/v1/customers
Flow
You can create a customer using:
- Created with credit card payment source
- Create with one-time token
- Create with vault token
- Create with vault token and without gateway Id
Request body
| field | required[flow] | type | description |
|---|---|---|---|
| token | +2 | string(UIID) | One-time token with all the payment source information |
| reference | - | string | Manually defined reference for customer in payment systems |
| description | - | string | Customer description. This is customer internal description |
| company_name | - | string | Customer company name |
| first_name | - | string | Customer first name |
| last_name | - | string | Customer last name |
| - | string | Customer email | |
| phone | - | string(E.164) | Customer phone in E.164 international notation (Example: +12345678901) |
| default_source | + | string (24 hex characters) | Payment source used by default |
| payment_source | + | object | Object with payment information |
| payment_source.gateway_id | -4 | string (24 hex characters) | Gateway id |
| payment_source.vault_token | +3 | string (UIID) | Vault token |
| payment_source.type | + | string | Type of payment. card for payment with credit card |
| payment_source.card_name | +1 | string | Cardholder name (as on card) |
| payment_source.card_number | +1 | string(numeric) | Card number |
| payment_source.expire_month | +1 | string(mm) | Card expiration month mm |
| payment_source.expire_year | +1 | string(yyyy) | Card expiration year |
| payment_source.card_ccv | -1 | string(numeric) | Card CCV number |
| payment_source.address_line1 | - | string | Customer Address, line 1 |
| payment_source.address_line2 | - | string | Customer Address, line 2 |
| payment_source.address_state | - | string | Customer Address, State |
| payment_source.address_country | - | string | Customer Address, Country Code |
| payment_source.address_city | - | string | Customer Address, City |
| payment_source.address_postcode | - | string | Customer Address, Postcode |