https://api.payload.co/payment_methods
Nested Objects
https://api.payload.co/payment_methods/{id}/account
https://api.payload.co/payment_methods/{id}/customer
https://api.payload.co/payment_methods/{id}/processing_agreement
Example
{
"id": "pm_DuYRmLn4QLpwYv5cvQqofFyw",
"object": "payment_method",
"account_holder": "string",
"account_id": "acct_1wBXjvBX5OQGQsvi9GqdW1wX0",
"attrs": {},
"bank_name": "string",
"birth_date": "2022-02-02",
"created_at": "2022-02-02 21:11:49",
"customer_id": "acct_SGyr58SPsE0Gv2YloX3Lgwlh",
"default_payment_method": false,
"description": "string",
"email": "[email protected]",
"keep_active": false,
"modified_at": "2022-02-02 21:11:49",
"phone_number": "(123) 456-7890",
"processing_agreement": {},
"ssn_last4": "numeric",
"transfer_type": "send-only",
"type": "card",
"verification_status": "not-verified",
"bank_account": {
"account_class": "personal",
"account_currency": "USD",
"account_number": "numeric",
"account_type": "checking",
"routing_number": "numeric"
},
"billing_address": {
"city": "string",
"country_code": "string",
"postal_code": "postal_code",
"state_province": "string",
"street_address": "string",
"unit_number": "string"
},
"card": {
"card_brand": "american_express",
"card_code": "numeric",
"card_number": "numeric",
"card_type": "credit",
"expiry": "expiry"
}
}
Attributes | Description |
---|---|
id string readonly |
Object ID |
object string readonly |
Value: payment_method |
account_holder string readonly: update |
Name of business or individual owner of the account |
account_id id non-default |
ID of the associated Customer or Processing Account object |
attrs json |
Custom object attributes |
bank_name string readonly |
Bank account name |
birth_date date non-default readonly: update |
Account holder's birth date |
created_at datetime readonly |
Timestamp object was created |
customer_id id |
ID of the associated Customer or Processing Account object |
default_payment_method bool |
If enabled, this method can be used as the default for the account |
description string readonly |
A readable description for the payment method |
email |
Account holder's email |
keep_active bool readonly: update |
Set to false for one-time use payment methods |
modified_at datetime readonly |
Timestamp object was last updated |
phone_number phone |
Account holder's phone number |
processing_agreement object |
Associated Processing Agreement object |
ssn_last4 numeric non-default readonly: update |
Account holder's ssn last 4 |
transfer_type string readonly: update |
Values: send-only receive-only two-way |
type string required |
Values: card bank_account |
verification_status string readonly |
Values: not-verified verified owner-verified |
bank_account: | |
---|---|
account_class string readonly: update |
Values: personal business |
account_currency string readonly: update |
Values: USD CAD |
account_number numeric readonly: update |
Bank account number |
account_type string readonly: update |
Values: checking savings |
routing_number numeric readonly: update |
Bank routing number for the account |
billing_address: | |
---|---|
city string |
City of the company |
country_code string |
Country code of the billing address |
postal_code postal_code required |
Postal code of the billing address |
state_province string |
State of the billing address |
street_address string |
Street address of the billing address |
unit_number string |
Unit number of the billing address |
card: | |
---|---|
card_brand string readonly |
Values: american_express visa discover mastercard opticard |
card_code numeric |
CVV code on back of card |
card_number numeric readonly: update |
Credit/Debit card number |
card_type string readonly: method |
Values: credit debit gift prepaid |
expiry expiry required |
Expiration date of the card |