Get a payment method
The payment_methods.get operation: GET /api/v1/payment_methods/{id} in the REST API and the payment_methods_get tool in the MCP server.
GET
/api/v1/payment_methods/{id}Reads a saved payment method: its type, card details (no number), customer and whether it is the default.
At a glance
- REST:
GET /api/v1/payment_methods/{id} - MCP tool:
payment_methods_get - Operation ID:
payment_methods.get - Scope: Brand
- Permission:
customers:read - Risk tier:
read - Dry run: Not supported
- Idempotency: Not needed (read only)
- Modes: Test and live
- Authentication: API key with the
customers:readscope - Since: M5
Request
Path parameters
| Field | Type | Description |
|---|---|---|
id | pm_… ID |
Query parameters
This operation takes no query parameters.
Response
200 OK with a JSON object:
| Field | Type | Description |
|---|---|---|
id | pm_… ID | |
object | "payment_method" | |
livemode | boolean | |
brandId | brd_… ID | |
customerId | cus_… ID | |
processor | one of stripe, mollie, fake | |
processorConnectionId | pcon_… ID | |
processorRef | object | |
processorRef.paymentMethodId | string | The processor's ID of the method (Stripe pm_…). |
type | string | card, sepa_debit, … as the processor reports it. |
card | object or null | |
isDefault | boolean | Charged for the customer's subscriptions unless one names another. |
source | one of checkout, setup | |
createdAt | date-time | |
detachedAt | date-time or null |
Examples
A saved card
HTTP
GET /api/v1/payment_methods/pm_01m4tx5nj8emwbyf7y9vcf47zd
Authorization: Bearer or_test_…
Response (200):
JSON
{
"id": "pm_01m4tx5nj8emwbyf7y9vcf47zd",
"object": "payment_method",
"livemode": false,
"brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4",
"customerId": "cus_01m4tx5nj8emwbyf7y9vcf47z4",
"processor": "stripe",
"processorConnectionId": "pcon_01m4tx5nj8emwbyf7y9vcf47zf",
"processorRef": {
"paymentMethodId": "pm_1QExampleCard"
},
"type": "card",
"card": {
"brand": "visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2029,
"country": "DE"
},
"isDefault": true,
"source": "checkout",
"createdAt": "2026-10-13T12:00:00.000Z",
"detachedAt": null
}
Errors
| Code | HTTP status | When | What to do |
|---|---|---|---|
resource_not_found | 404 | No payment method (or customer) with this ID is visible to the request. | Check the ID and that your credentials are scoped to the right organization, entity, brand and mode. |
permission_denied | 403 | You can't see this brand's customers (customers:read). | Ask an organization owner or admin for a role or scope that allows this action. |
It can also return these common errors: validation_failed, api_version_unsupported, authentication_required, api_key_invalid, scope_required, dry_run_not_supported, rate_limited, internal_error.