Skip to main content

Payment Methods

Learn more about the Payment Method resource

A Payment Method resource represents the payment methods used by your customer to complete a transaction. You can use them with Payment Intent resources to collect payments using saved payment methods.

The Payment Method Resource​

{
  "id": "pm_nzs2WapbndMweArg3TCBMVEn2665aekd",
  "resource": "payment_method",
  "type": "gcash",
  "details": {
    "status": "authorized",
    "phone": "****1234"
  },
  "billing_details": {
    "name": "Juan Dela Cruz",
    "email": "juan@gmail.com",
    "phone": null,
    "address": {
      "line1": null,
      "line2": null,
      "city": null,
      "state": null,
      "postal_code": null,
      "country": null
    }
  },
  "livemode": true,
  "metadata": null,
  "allow_redisplay": "unspecified",
  "created_at": 1780366964,
  "updated_at": 1780366964
}

Attributes​

id string

Unique identifier for the resource. The prefix is pm_.

resource string

Represents the resource's type. The value is payment_method.

type string

The payment method type. Possible values are gcash, maya, or card.

details hash

Supporting details about the payment method. This attribute varies by payment method.

billing_details hash

Show child attributes

name string

The billing name of the customer

email string

The billing e-mail address of the customer

phone string

The billing phone of the customer

address hash

Show child attribute

line1 string

The billing Address Line1 of the customer

line2 string

The billing address line2 of the customer

city string

The billing address city of the customer

state string

The billing address state of the customer

postal_code string

The billing address postal code of the customer

country string

The billing address country of the customer in two-letter ISO format.

livemode boolean

The value is true if the resource's mode is live or the value is false if the resource mode is test.

See the mode guide for more details.

metadata hash

A set of key-value pairs of the payment method resource.

The value is null if there is no metadata for the payment method.

created_at timestamp

The time the resource was created and measured in seconds since the Unix epoch.

updated_at timestamp

The time the resource was updated and measured in seconds since the Unix epoch.