Customers represent payers in your integration. Create a customer with your own customer_id to associate their personal details and saved payment instruments with your business records.
To save a card, create a checkout for that customer with purpose = SETUP_RECURRING_PAYMENT, then process it with the payer's consent and mandate details. See the tokenization guide.
Use the Customers endpoints to create, retrieve, or update customer details and to list or deactivate saved payment instruments. For subsequent payments, process a new checkout with the saved instrument's token and its associated customer_id.
Objects:
- Create a customerPOST
/v0.1/customersCreates a customer using the
customer_idyou supply. Choose an identifier that maps to the payer in your own system and reuse it when retrieving the customer or associating checkouts and saved payment instruments with them.OAuth scopes: Requires one of:
payment_instruments,customers.write. - Retrieve a customerGET
/v0.1/customers/{customer_id}Retrieves a saved customer using the
customer_idyou supplied when creating the customer.OAuth scopes: Requires one of:
payment_instruments,customers.read. - Update a customerPUT
/v0.1/customers/{customer_id}Updates an identified saved customer resource's personal details.
The request only overwrites the parameters included in the request, all other parameters will remain with their initially assigned values.
OAuth scopes: Requires one of:
payment_instruments,customers.write. - List payment instrumentsGET
/v0.1/customers/{customer_id}/payment-instrumentsLists all payment instrument resources that are saved for an identified customer.
OAuth scopes: Requires one of:
payment_instruments,customers.read. - Deactivate a payment instrumentDELETE
/v0.1/customers/{customer_id}/payment-instruments/{token}Deactivates an identified card payment instrument resource for a customer.
OAuth scopes: Requires one of:
payment_instruments,customers.write.