A Payment method represents a customer’s payment instrument. A Payment method can be used to add funds to a customer’s balance. Ansa currently supports credit and debit cards, US bank accounts, and Apple Pay and Google Pay as payment methods. Gift cards from select providers are also supported via Ansa APIs, however these are redeemed directly into the customer's balance without creating a payment method.
| Field | Type | Description | Example value |
|---|
id | string | Unique identifier for the payment method. | 2aa3d415-8256-4d0e-97a1-7cd0a09e0230 |
type | string | The type of the payment method.Currently supported:
credit_card
apple_pay
google_pay
plaid
bank_account
| |
preferred | boolean | true value of this attribute indicates that the payment method is preferred.
- Please note that the attribute is not visible for payment methods that are not marked as preferred.
apple_pay and google_pay payment methods cannot be marked as preferred as they are ephemeral.
| |
card | object | A Card object contains additional metadata for the associated card. | |
| Field | Type | Description | Example value |
|---|
accountNumberLast4 | string | The last four digits of the associated bank account. | |
routingNumber | string | The full routing number for the bank. | |
name | string | The full name of the bank. | |
| Field | Type | Description | Example value |
|---|
lastFour | string | The last four digits of the associated card data. | |
firstSix | string | The first six digits of the associated card data. | |
brand | string | The card brand. Possible values are:
amex
diners
discover
jcb
mastercard
unionpay
visa
unknown
| |
fingerprint | string | Uniquely identifies the content of the card number. It can be used to determine whether two customers who have signed up have used the same card number. | |