v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

CUSTOMERS

Create a card-on-file customer

Creates a card-on-file (COF) customer record for e-commerce transations. If you do not want to save card data for the customer, use the create a customer in the Platform API.

post/v1/customers

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Request body

ecomind'ecom' | 'moto'

Indicates who entered the card data used for a charge - customer (ecom) or merchant (moto).

emailstring required

Customer's email address.

firstNamestring

Customer's first name.

lastNamestring

Customer's last name.

namestring

Customer's full name.

sourcestring required

Payment source to charge, such as token or ACH.

phonestring

Customer's phone number.

Response

Successful response. Card-on-file (COF) customer record for e-commerce transactions created.

createdinteger required

Displays results based on the object's created field. Values: String with a Unix timestamp (in milliseconds). Dictionary of multiple options describing a time range.

currencystring

Three-letter ISO 4217 currency code.

default_sourcestring nullable

Universally unique identifier (UUID) of the customer's default payment source.

delinquentboolean nullable

For an invoice charged automatically, delinquent is true if the invoice's charge fails. For an invoice that is sent to the customer, delinquent is true if the invoice is not paid by its due date.

descriptionstring nullable

Description about the customer.

emailstring nullable

Customer email address.

idstring required

Unique identifier of the customer.

metadataobject

Set of key-value pairs that you can attach to the object. This parameter is useful for storing additional information about the object in a structured format. Length: Maximum 500 characters

object'customer' required

Object type. Objects with the same type have the same value.