# Find one Payment Method

`GET /v2/payment-methods/{id}`

Core API v2, Payment Methods.

Retrieve a Payment Method by its ID

**Authentication:** Send `Authorization: Bearer <token>`. To authenticate, generate a Secret API Key from your ODUS Dashboard and include it in the `Authorization` header as follows: `Authorization: Bearer <YOUR_SECRET_API_KEY>`

## Parameters

### Path parameters

- `id` (string, required)

## Responses

### `200`

OK

Type: object (PaymentMethodDTO).

- `createdAt` (string (date-time), required): The date and time when the entity was created. Example: `2024-02-18T12:00:00Z`.
- `updatedAt` (string (date-time), required, nullable): The date and time when the entity was last updated. Example: `2024-02-21T12:15:00Z`.
- `metadata` (map of string to string, nullable): Metadata used by merchants to store additional information about the entity.
- `id` (string, required): The ID of the payment method. Example: `pm_2QC7PqoUeOxQEWscJJt6B3PkvyL`.
- `type` (string, required): The type of the payment method. One of `card`, `paypal`, `applePay`. Example: `card`.
- `customer` (string, required, nullable): The ID of the customer who this payment method belongs to. Example: `cus_2QC7PqoUeOxQEWscJJt6B3PkvyL`.
- `isDefault` (boolean, required): Whether the payment method is the default one for the customer. Example: `false`.
- `card` (object, required, nullable): The card details of the payment method. Set only when `type` is `card`.
  - `brand` (string, required, nullable): The brand of the card. One of `visa`, `mastercard`, `amex`, `discover`. Example: `amex`.
  - `lastFour` (string, required): The last four digits of the card. Example: `1234`.
  - `bin` (string, required): The card BIN/IIN (Bank/Issuer Identification Number) - 4 to 8 digits. Example: `123456`.
  - `expMonth` (string, required, nullable): The expiration month of the card (in MM format) Example: `12`.
  - `expYear` (string, required, nullable): The expiration year of the card (in YYYY format) Example: `2025`.
  - `cardholderName` (string, required, nullable): The name on the card. Example: `John Doe`.
- `applePay` (object, required, nullable): The Apple Pay details of the payment method. Set only when `type` is `applePay`.
  - `displayName` (string, required, nullable): The display name of the Apple Pay payment method. Example: `MasterCard 1234`.

### `202`

The merchant is entitled but its environment is not provisioned yet. Provisioning has been kicked off (exactly once) and is in progress; retry the request — it succeeds once the environment is ready. Returned only for identity-token (dashboard) requests bound to a merchant, not for secret-key API calls; any such endpoint can return it while provisioning is underway.

Type: object (ProvisioningInProgress).

- `status` (string, required): Signals the merchant environment is still being provisioned. One of `provisioning`.
- `merchantAccountId` (string, required): The merchant account whose environment is being provisioned. Example: `dAI3aa87ROOeupeBCjNSKCOBOisBCYjB`.

### Errors

- `400`: The request was rejected. `type` is `invalid_request_error` when the request itself is at fault — `errors` then lists every problem found, with field-attributable entries prefixed by the field’s path; or `invalid_state_error` when the request was well-formed but the resource is not in a state that allows it.
- `401`: No API key was supplied, or the key is not valid. `type` is `authentication_error`.
- `403`: The API key is valid but lacks the permission this operation requires. `type` is `permission_error`.
- `404`: No resource exists with the requested identifier. `type` is `not_found_error`.
- `429`: Too many requests. A limit applies per operation; requests to other operations are unaffected. `type` is `rate_limit_error`. Use the `Retry-After-global` header to know when to retry.
- `500`: The request could not be completed because of an unexpected error. `type` is `api_error`.
- `503`: The request could not be served right now: the API is temporarily at capacity, or a dependency needed to authorize the request is unavailable — the auth service that verifies credentials, or the entitlement lookup behind it. `type` is `api_error`. It is raised before the operation runs, so the request had no effect, and unlike a plain 500 the condition is transient: retry with backoff.
- `504`: The request exceeded the processing time limit and was abandoned. `type` is `api_error` and `code` is `timeout` — unlike a plain 500 the request may still have taken effect, so retry with the same idempotency key rather than blindly.

Every error response has the same body: see [Errors](https://docs.odus.com/docs/guides/api-features/errors.md).

---

Generated from the Core API v2 OpenAPI document, https://api.odus.com/openapi.v2.json. Interactive page: https://docs.odus.com/docs/api/core/v2/payment-method-controller-find-one