Payment Methods

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_16cdhAsKmTCeVax29I7W2FMVa",
  "object": "payment_method",
  "account_holder": "string",
  "account_id": "acct_voU2lAiu4rmlv6jlJkfyvfvS",
  "attrs": {},
  "birth_date": "2021-07-07",
  "created_at": "2021-07-07 23:19:32",
  "customer_id": "acct_96UoPe1iMwMhQNlM5eiVmhDA",
  "default_payment_method": true,
  "description": "string",
  "email": "email@address.com",
  "keep_active": false,
  "modified_at": "2021-07-07 23:19:32",
  "phone_number": "(123) 456-7890",
  "processing_agreement": {},
  "receiver_quality": 129,
  "ssn_last4": "numeric",
  "type": "card",
  "bank_account": {
    "account_class": "personal",
    "account_currency": "USD",
    "account_number": "numeric",
    "account_type": "checking",
    "routing_number": "numeric"
  },
  "billing_address": {
    "city": "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
Name of the account holder
account_id
id non-default
ID of the associated Customer or Processing Account object
attrs
json
Custom object attributes
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
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
receiver_quality
int readonly
None
ssn_last4
numeric non-default readonly: update
Account holder's ssn last 4
type
string required
Values: card bank_account
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
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