Customers

Customer objects are used to group various other useful object on our Platform, e.g. CreditCard, Address, BankAccount.

Also, you can link Customer objects in Pencepay with the customer records in your system, which will give you a great way to both navigate data using our tools, and execute payments in a logical and structured way in your code.

Generally we recommend creating Customer records if you already have customer/user records (and the associated IDs) in your application, or if you need to store your customer's payment details for executing future payments.

Object properties

uid

Unique ID of the Customer in our system

company

Name of the company (if the Customer record represents a business entity)

firstName

First name of the Customer

lastName

Last name of the Customer

email

Email of the Customer

phone

Phone number of the Customer

mobile

Mobile number name of the Customer

description

Description of the Customer

created

Object creation timestamp

Object relations

creditCards

CreditCard objects saved for this Customer

bankAccounts

BankAccount objects saved for this Customer

addresses

Address objects saved for this Customer

customData

Map (Dictionary) of the custom data fields and values which you provide, which is saved on the gateway with this object.