RevKeenDocs
StatusSupport
API Reference

Get customer payment methods

Retrieve all payment methods for a customer --- **Related endpoints** - `GET /customers/{customerId}/invoices` — List customer invoices - `GET /customers/{customerId}/subscriptions` — List customer subscriptions - `GET /customers/{customerId}/orders` — List customer orders - `GET /customers/{customerId}/payments` — List customer payments - `PUT /customers/external/batch` — Batch upsert customers by external ID - `POST /customers` — Create a new customer - `GET /customers` — List customers - `GET /customers/{id}` — Get customer by ID **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

GET
/customers/{id}/payment-methods

Retrieve all payment methods for a customer

Related endpoints

  • GET /customers/{customerId}/invoices — List customer invoices
  • GET /customers/{customerId}/subscriptions — List customer subscriptions
  • GET /customers/{customerId}/orders — List customer orders
  • GET /customers/{customerId}/payments — List customer payments
  • PUT /customers/external/batch — Batch upsert customers by external ID
  • POST /customers — Create a new customer
  • GET /customers — List customers
  • GET /customers/{id} — Get customer by ID

Common errors

  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Path Parameters

id*string

Customer UUID

Formatuuid

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/customers/00000000-0000-0000-0000-000000000000/payment-methods" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "object": "payment_method",      "public_id": "string",      "type": "card",      "status": "active",      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",      "is_default": true,      "card": {        "brand": "visa",        "last4": "stri",        "exp_month": 1,        "exp_year": 0,        "funding": "credit"      },      "us_bank_account": {        "bank_name": "string",        "last4": "stri",        "routing_number_last4": "stri",        "account_type": "checking"      },      "bacs_direct_debit": {        "sort_code": "string",        "account_number_last4": "string",        "bank_name": "string",        "mandate_id": "string",        "mandate_ref": "string",        "mandate_status": "string"      },      "billing_details": {        "name": "string",        "email": "user@example.com",        "phone": "string",        "address": {          "line1": "string",          "line2": "string",          "city": "string",          "state": "string",          "postal_code": "string",          "country": "string"        }      },      "metadata": {        "property1": null,        "property2": null      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

List customer orders GET

Retrieve all orders for a specific customer --- **Related endpoints** - `GET /customers/{customerId}/invoices` — List customer invoices - `GET /customers/{customerId}/subscriptions` — List customer subscriptions - `GET /customers/{customerId}/payments` — List customer payments - `PUT /customers/external/batch` — Batch upsert customers by external ID - `POST /customers` — Create a new customer - `GET /customers` — List customers - `GET /customers/{id}` — Get customer by ID - `PATCH /customers/{id}` — Update customer details **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

Get customer payment rail availability GET

Return per-rail availability for a customer, including mandate state and last successful rail usage. --- **Related endpoints** - `GET /customers/{customerId}/invoices` — List customer invoices - `GET /customers/{customerId}/subscriptions` — List customer subscriptions - `GET /customers/{customerId}/orders` — List customer orders - `GET /customers/{customerId}/payments` — List customer payments - `PUT /customers/external/batch` — Batch upsert customers by external ID - `POST /customers` — Create a new customer - `GET /customers` — List customers - `GET /customers/{id}` — Get customer by ID **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.