Skip to main content
GET
/
v1
/
payment_methods
List all payment methods
curl --request GET \
  --url https://api.yorlet.com/v1/payment_methods \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "payment_method",
      "billing_details": {
        "address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "country": "<string>",
          "postal_code": "<string>",
          "state": "<string>"
        },
        "email": "<string>",
        "name": "<string>",
        "phone": "<string>"
      },
      "customer": "<string>",
      "status": "chargeable",
      "type": "bacs_debit",
      "bacs_debit": {
        "fingerprint": "<string>",
        "last4": "<string>",
        "sort_code": "<string>"
      },
      "account": "<string>",
      "deleted": false
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A object with a data property that contains an array of payment methods.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
(Bacs debit · object | Bank transfer · object | Card present · object | Card · object | Pay by bank · object | Sepa debit · object)[]
required

The Bacs debit payment method.