Customer

A Customer object represents an individual customer of your business. Every Customer has an associated wallet balance, and can add funds and spend funds from their balance.

Customer attributes

Field	Type	Description	Example value
`id`	`string`	Unique identifier for the customer.	`2aa3d415-8256-4d0e-97a1-7cd0a09e0230`
`merchantId`	`string`	Identifier of the merchant for this customer.	`83ac5214-5c2b-4d41-83a2-ffc58903f392`
`balance`	`object`	Balance object containing details about the customer balance.
`email`	`string`	The customer email address.
`phone`	`string`	The customer phone number.	`tel:+1-510-123-4567`
`billingDetails`	`object`	Billing details object containing optional billing details about the user, if available.
`metadata`	`object`	A set of key-value pairs that you can attach to a customer.
`ansaMetadata`	`object`	Ansa provides a set of key-value pairs containing user data. This includes the relevant payment service provider (PSP) user ID and the user's referral code.
`status`	`string`	The customer status. Possible values are: `active` `deactivated` `closed`
`walletStatus`	`string`	Only used for merchants with the verified wallet feature. The status of the wallet. Possible values are: `default` `verified`

Balance attributes

The Customer object has an associated Balance object that will also be returned when you request the Customer.

ℹ️
Amounts are integers
All amount parameters and returned values are integers. These amounts represent the lowest denomination of the provided currency code, such as cents for USD. For example, "amount": 1000 would indicate an amount of $10.00.

Field	Type	Description	Example value
`amount`	`integer`	The integer amount in the lowest denomination of the provided currency code.	`500` (equivalent to $5)
`currency`	`string`	Three letter ISO currency code.	`USD`

Billing details attributes

A Customer object contains a Billing details object when the information is available.

Field Type Description Example value

firstName string Customer first name.

lastName string Customer last name.

Field	Type	Description	Example value
`firstName`	`string`	Customer first name.
`lastName`	`string`	Customer last name.
`address`	`object`	An object representing a physical address. Attributes are: line1 `string` line2 `string` city `string` state `string` postalCode `string` country `string`	`{ "line1": "1234 Ansa St.", "line2": "suite 123", "city": "San Francisco", "state": "CA", "postalCode": "94100", "country": "USA", }`

address

object

An object representing a physical address.

Attributes are:

line1 string
line2 string
city string
state string
postalCode string
country string

{
			"line1": "1234 Ansa St.",  
			"line2": "suite 123",  
		  "city": "San Francisco",  
			"state": "CA",  
		  "postalCode": "94100",  
		  "country": "USA",  
		}