GET
/
payment_methods
curl --request GET \
  --url https://api.chargeapi.co/v1/payment_methods \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "object": "list",
  "data": [
    {
      "id": null,
      "object": null,
      "billing_details": {
        "address": {
          "city": null,
          "country": null,
          "line1": null,
          "line2": null,
          "postal_code": null,
          "state": null
        },
        "email": null,
        "name": null,
        "phone": null
      },
      "created": null,
      "details": {
        "brand": null,
        "last4": null,
        "exp_month": null,
        "exp_year": null
      },
      "driver": null,
      "fleet": null,
      "type": null
    }
  ],
  "has_more": true,
  "url": "<string>"
}

Query Parameters

limit
integer

Maximum number of payment methods to return (default 10).

Required range: 1 <= x <= 100
starting_after
string

Pagination cursor; returns items after this payment-method ID.

ending_before
string

Pagination cursor; returns items before this payment-method ID.

type
enum<string>

Filter results by payment-method type.

Available options:
card
expand
string[]

Specifies related objects to expand in each payment method (for example, expand[]=driver or expand[]=fleet).

Body

application/json · object

Response

200
application/json

A dictionary with a data property that contains an array of up to limit Payment Method objects, starting after Payment Method starting_after. Each entry in data is a separate Payment Method object. If no additional payment methods are available, the array is empty.

The response is of type object.