GET
/
payment_methods
List Payment Methods
curl --request GET \
  --url https://api.chargeapi.co/v1/payment_methods \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "object": "list",
  "url": "<string>",
  "has_more": true,
  "data": [
    {
      "id": "<string>",
      "object": "<string>",
      "bank_account": {
        "bank_name": "<string>",
        "country": "<string>",
        "currency": "<string>",
        "fingerprint": "<string>",
        "last4": "<string>",
        "status": "pending"
      },
      "billing_details": {
        "address": {
          "city": null,
          "country": null,
          "line1": null,
          "line2": null,
          "postal_code": null,
          "state": null
        },
        "email": null,
        "name": null,
        "phone": null
      },
      "card": {
        "brand": "<string>",
        "exp_month": 123,
        "exp_year": 123,
        "fingerprint": "<string>",
        "last4": "<string>"
      },
      "created": 123,
      "driver": "<string>",
      "fleet": "<string>",
      "type": "bank_account",
      "wallet": {
        "balance": 123,
        "currency": "<string>",
        "fingerprint": "<string>",
        "status": "active"
      }
    }
  ]
}

Query Parameters

driver
string

Limit results to payment methods attached to this driver. Cannot be combined with fleet.

ending_before
string

A cursor for pagination. Returns objects listed before the given ID.

fleet
string

Limit results to payment methods attached to this fleet. Cannot be combined with driver.

limit
integer
default:10

Number of objects to return (default 10, max 100).

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

A cursor for pagination. Returns objects listed after the given ID.

type
enum<string>

Filter results by payment method type.

Available options:
card,
bank_account,
wallet

Body

application/json · object

Response

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.