Payment Methods

https://api.payload.com/payment_methods

Nested Objects

https://api.payload.com/payment_methods/{id}/account

https://api.payload.com/payment_methods/{id}/created_from

https://api.payload.com/payment_methods/{id}/customer

https://api.payload.com/payment_methods/{id}/gateways

https://api.payload.com/payment_methods/{id}/processing_agreement

Example

{
  "id": "pm_eVfKZA87CQY9Fw12bO91z0Bk",
  "object": "payment_method",
  "account_holder": "string",
  "account_id": "acct_iX6Gp4na1OMnV4pIeP2rL1Ni",
  "attrs": {},
  "bank_name": "string",
  "birth_date": "2024-08-21",
  "created_at": "2024-08-21 13:35:03",
  "customer_id": "acct_1jSF7P9qFTiNx2oCFPYo5gke5",
  "default_credit_method": false,
  "default_deposit_method": true,
  "default_payment_method": false,
  "default_reversal_method": true,
  "description": "string",
  "email": "[email protected]",
  "keep_active": false,
  "modified_at": "2024-08-21 13:35:03",
  "phone_number": "(123) 456-7890",
  "ssn_last4": "numeric",
  "status": "active",
  "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": "string",
    "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	None
`customer_id` id	ID of the associated Customer or Processing Account object
`default_credit_method` bool	If enabled, this method can be used as the default for credits on the account
`default_deposit_method` bool	If enabled, this method can be used as the default for deposits on the account
`default_payment_method` bool	If enabled, this method can be used as the default for payments on the account
`default_reversal_method` bool	If enabled, this method can be used as the default for reversals on the account
`description` string	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	None
`phone_number` phone	Account holder's phone number
`ssn_last4` numeric non-default readonly: update	Account holder's ssn last 4
`status` string readonly	Values: active inactive declining
`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` string 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	Values: credit debit gift prepaid
`expiry` expiry required	Expiration date of the card