---
title: "Obtener Payment Method"
method: GET
path: "/payment_method"
tags: ["Payment Methods"]
deprecated: true
---

# Obtener Payment Method

`GET /payment_method`

## Request

- Base URL: `https://api.trytoku.com`
- URL: `https://api.trytoku.com/payment_method`
- Auth: API key in header `x-api-key`

> **Deprecated.**

**Obsoleto.** Usar `GET /payment-methods/{id}`, que entrega la misma información y acepta las versiones posteriores al 2024-05-22. Este endpoint se mantiene por compatibilidad y se va a retirar.

Devuelve un Payment Method con sus datos agregados.

Junto al medio de pago devuelve el Customer, el gateway, la Account y los productos y Subscriptions asociados, para no tener que consultarlos por separado.

Acepta el identificador de Toku (`id`) o el de la Organization (`external_id`). Si se envían ambos, se usa `id`.

Acepta el header `x-api-version` para elegir la versión de la respuesta, la misma que entrega `GET /payment-methods/{id}`. Si no se envía, o es anterior al 2024-05-22, se usa la versión de esa fecha.

## Query parameters

- `id` string: Identificador del Payment Method. Alternativo a `external_id`; debe venir uno de los dos.
- `external_id` string: Identificador del Payment Method en el sistema de la Organization. Se usa cuando no se tiene `id`; si ambos vienen, manda `id`.

## Headers

- `x-api-version` string, date: Versión del API para esta petición, como cualquier fecha `YYYY-MM-DD`. Fija el contrato de la respuesta; si se omite, se deriva de la fecha de creación de la organización.
- `x-account-key` string

## Response `200`

Successful Response

- PaymentMethodDTOAggregatedPaymentMethodV2: Misma forma que :class:`DTOAggregatedPaymentMethodV1` más un campo ``updated_fields`` que lleva solo lo que cambió en la llamada a ``update_payment_method`` en curso. ``updated_fields`` es un modelo tipado :class:`DTOUpdatedFields`, así el contrato queda explícito: cualquier comercio que se integre con el webhook conoce el conjunto exacto de claves que puede recibir, y pydantic valida la forma al momento de construir el objeto. Diseñado para que el mismo DTO pueda servir a varios tipos de evento de webhook (attached, updated, etc.).
  - `customer` DTOCustomerV2
    - `email` string
    - `external_id` string
    - `government_id` string
    - `id` string, required
    - `metadata` object
    - `name` string
    - `phone_number` string
  - `gateway` 'transbank_oneclick' | 'klap_oneclick' | 'patpass' | 'toku_pac' | 'fintoc_pac' | 'universo_pac' | 'external_pac' | 'ecert_pac' | 'manual_pac' | 'internal_psp' | 'domiciliation' | 'mx_banco_bbva' | 'mx_banco_bancomer' | 'mx_banco_banbajio' | 'mx_banco_banorte' | 'mx_banco_banorte_h2h' | 'mx_banco_banregio' | 'mx_banco_bbva_bancomer' | 'mx_banco_citibanamex' | 'mx_banco_santander' | 'mx_banco_scotiabank' | 'mx_banco_scotiabank_h2h_external' | 'evo_payments' | 'conekta' | 'stripe' | 'kushki' | 'openpay' | 'paypal' | 'getnet' | 'fiserv' | 'transbank' | 'toku_gateways' | 'payment_orchestration' | 'cards_batch_mx' | 'cards_batch_mx_recurring_pst' | 'amex_batch_mx_recurring_pst' | 'atoa_batch_mx_recurring_pst' | 'braintree' | 'cielo' | 'pagarme' | 'belvo' | 'iniciador' | 'qi_tech' | 'mit' | 'mit_amex' | 'rede' | 'br_banco_do_brasil' | 'br_banco_itau' | 'br_banco_santander' | 'br_banco_citibank' | 'br_banco_de_brasilia_via_accesstage' | 'br_santander_via_accesstage' | 'br_bradesco_via_accesstage' | 'br_banco_do_brasil_via_accesstage' | 'br_c6_via_accesstage' | 'br_sicoob_via_accesstage' | 'br_caixa_via_accesstage' | 'br_itau_via_accesstage' | 'br_santander_brasil_via_accesstage' | 'br_sudameris_via_accesstage' | 'br_abn_via_accesstage' | 'br_inter_via_accesstage' | 'br_hsbc_via_accesstage' | 'br_sicoob' | 'worldpay' | 'br_caixa' | 'br_btg' | 'br_banco_itau_boleto' | 'br_banco_bradesco_boleto' | 'br_sicredi_boleto' | 'br_banco_de_brasilia': Integración a través de la cual se inscribió un medio de pago y por la que se cobrará después. Combina el adquirente o banco con la modalidad de inscripción — por ejemplo `transbank_oneclick` es una tarjeta inscrita en Oneclick de Transbank, y `fintoc_pac` un mandato de descuento automático inscrito vía Fintoc. Es un conjunto distinto de `PaymentIntentGateway`, que identifica por dónde sale un cobro puntual: no todo gateway capaz de cobrar sirve para inscribir un medio de pago.
  - `id_account` string
  - `id_checkout_session` string
  - `payment_method` PaymentMethodDTOPaymentMethodV7, required: Un Payment Method es la forma de pago que un Customer deja inscrita para que Toku le cobre después: una tarjeta guardada, una cuenta bancaria para PAC o domiciliación, un Pix o un boleto recurrente. Guarda en qué estado quedó la inscripción —de eso depende que se le pueda cobrar—, con qué procesador se cursa el cobro y el detalle del medio inscrito, que viaja en `card`, `bank_account` o `pix` según su `type`; un `boleto` no trae detalle. Los datos sensibles nunca viajan aquí: la tarjeta se identifica por su token y sus últimos dígitos.
    - `bank_account` PaymentMethodDTOBankAccountPaymentMethodV1: Datos de la cuenta bancaria con la que se cobra un Payment Method de tipo `bank_account`. Es la cuenta que el Customer deja registrada para que se le cargue por PAC o domiciliación bancaria.
      - `account_number` string: Número de la cuenta bancaria.
      - `account_type` union: Tipo de cuenta bancaria, por ejemplo corriente, vista o de ahorro.
        - '03' | '40': Tipo de cuenta de destino en México, en la codificación que usa el sistema de pagos mexicano: `03` para una tarjeta de débito y `40` para una CLABE interbancaria. El tipo determina cómo se interpreta el número de cuenta que lo acompaña.
        - string
      - `additional_data` object: Datos complementarios de la cuenta que registró la institución financiera.
      - `bank_id` string: Código de la institución financiera de la cuenta.
      - `bank_name` string: Nombre de la institución financiera de la cuenta.
      - `institution_country` 'CL' | 'MX' | 'BR': País, en código [ISO 3166-1 alfa-2](https://es.wikipedia.org/wiki/ISO_3166-1_alfa-2). Se limita a los países donde Toku opera: `CL` (Chile), `MX` (México) y `BR` (Brasil). El país determina qué medios de pago y qué productos de cobro están disponibles.
      - `name` string: Nombre del titular de la cuenta bancaria.
    - `card` CardPaymentMethod: Datos de la tarjeta con la que se cobra un Payment Method de tipo `card`. Nunca lleva el número completo ni el CVV: la tarjeta viaja identificada por su BIN, sus últimos dígitos y el token con el que el procesador la reconoce.
      - `additional_data` object: Datos complementarios de la tarjeta que registró el procesador.
      - `bank_id` string: Código del banco emisor de la tarjeta.
      - `bank_name` string: Nombre del banco emisor de la tarjeta.
      - `bin` string: Primeros dígitos de la tarjeta, que identifican al emisor y al tipo de producto.
      - `card_brand` string: Marca de la tarjeta, por ejemplo `visa` o `mastercard`.
      - `card_holder` string: Nombre del titular registrado en la tarjeta.
      - `card_type` union: Tipo de tarjeta: `credit`, `debit` o `prepaid`.
        - 'credit' | 'debit' | 'prepaid': Clase de tarjeta según quién financia el pago: `credit` crédito, `debit` débito y `prepaid` prepago.
        - string
      - `expiration_month` string: Mes de vencimiento de la tarjeta, de `01` a `12`.
      - `expiration_year` string: Año de vencimiento de la tarjeta.
      - `institution_country` 'CL' | 'MX' | 'BR': País, en código [ISO 3166-1 alfa-2](https://es.wikipedia.org/wiki/ISO_3166-1_alfa-2). Se limita a los países donde Toku opera: `CL` (Chile), `MX` (México) y `BR` (Brasil). El país determina qué medios de pago y qué productos de cobro están disponibles.
      - `last_digits` string: Últimos dígitos de la tarjeta, para que el cliente final la reconozca.
      - `three_d_secure` boolean: Indica si la tarjeta se inscribió con autenticación 3-D Secure del emisor.
      - `token` string: Token con el que el procesador identifica la tarjeta guardada. Reemplaza al número de tarjeta al momento de cobrar.
    - `card_brand` string: Marca de la tarjeta, por ejemplo `visa` o `mastercard`. Es nulo cuando el medio de pago no es una tarjeta.
    - `created_at` string, date-time: Fecha y hora en que se inscribió el medio de pago.
    - `external_id` string: Identificador que entrega la organización para reconocer el medio de pago en sus propios sistemas.
    - `gateway` 'transbank_oneclick' | 'klap_oneclick' | 'patpass' | 'toku_pac' | 'fintoc_pac' | 'universo_pac' | 'external_pac' | 'ecert_pac' | 'manual_pac' | 'internal_psp' | 'domiciliation' | 'mx_banco_bbva' | 'mx_banco_bancomer' | 'mx_banco_banbajio' | 'mx_banco_banorte' | 'mx_banco_banorte_h2h' | 'mx_banco_banregio' | 'mx_banco_bbva_bancomer' | 'mx_banco_citibanamex' | 'mx_banco_santander' | 'mx_banco_scotiabank' | 'mx_banco_scotiabank_h2h_external' | 'evo_payments' | 'conekta' | 'stripe' | 'kushki' | 'openpay' | 'paypal' | 'getnet' | 'fiserv' | 'transbank' | 'toku_gateways' | 'payment_orchestration' | 'cards_batch_mx' | 'cards_batch_mx_recurring_pst' | 'amex_batch_mx_recurring_pst' | 'atoa_batch_mx_recurring_pst' | 'braintree' | 'cielo' | 'pagarme' | 'belvo' | 'iniciador' | 'qi_tech' | 'mit' | 'mit_amex' | 'rede' | 'br_banco_do_brasil' | 'br_banco_itau' | 'br_banco_santander' | 'br_banco_citibank' | 'br_banco_de_brasilia_via_accesstage' | 'br_santander_via_accesstage' | 'br_bradesco_via_accesstage' | 'br_banco_do_brasil_via_accesstage' | 'br_c6_via_accesstage' | 'br_sicoob_via_accesstage' | 'br_caixa_via_accesstage' | 'br_itau_via_accesstage' | 'br_santander_brasil_via_accesstage' | 'br_sudameris_via_accesstage' | 'br_abn_via_accesstage' | 'br_inter_via_accesstage' | 'br_hsbc_via_accesstage' | 'br_sicoob' | 'worldpay' | 'br_caixa' | 'br_btg' | 'br_banco_itau_boleto' | 'br_banco_bradesco_boleto' | 'br_sicredi_boleto' | 'br_banco_de_brasilia': Integración a través de la cual se inscribió un medio de pago y por la que se cobrará después. Combina el adquirente o banco con la modalidad de inscripción — por ejemplo `transbank_oneclick` es una tarjeta inscrita en Oneclick de Transbank, y `fintoc_pac` un mandato de descuento automático inscrito vía Fintoc. Es un conjunto distinto de `PaymentIntentGateway`, que identifica por dónde sale un cobro puntual: no todo gateway capaz de cobrar sirve para inscribir un medio de pago.
    - `id` string, required: Identificador único del Payment Method.
    - `id_payment_instrument` string: Payment Instrument al que apunta el medio de pago: la tarjeta o cuenta concreta que Toku tiene guardada y que puede compartirse entre varios medios de pago.
    - `payment_method_metadata` object: Datos propios de la organización que se guardaron junto al medio de pago.
    - `pix` PixPaymentMethod: Dados do Pix com o qual se cobra um Payment Method do tipo `pix`, disponível apenas no Brasil. Reúne tanto o que identifica a conta do pagador quanto os artefatos com os quais o cliente final conclui o pagamento: o código QR, o código *copia e cola*, e o link para o qual ele é redirecionado.
      - `account_type` string: Tipo de conta bancária do pagador.
      - `additional_data` object: Dados complementares do Pix registrados pelo provedor.
      - `bank_id` string: Código da instituição financeira do pagador.
      - `bank_name` string: Nome da instituição financeira do pagador.
      - `copy_paste_code` string: Código *copia e cola* com o qual o cliente final paga pelo seu banco.
      - `end_to_end_id` string: Identificador com o qual o Banco Central do Brasil acompanha a transferência de ponta a ponta.
      - `error_code` string: Código com o qual o provedor respondeu à recusa. É nulo quando não houve recusa.
      - `error_message` string: Mensagem com a qual o provedor explicou a recusa. É nulo quando não houve recusa.
      - `expiration_date` string, date-time: Data e hora até a qual o código de pagamento permanece válido.
      - `institution_country` 'CL' | 'MX' | 'BR': País, en código [ISO 3166-1 alfa-2](https://es.wikipedia.org/wiki/ISO_3166-1_alfa-2). Se limita a los países donde Toku opera: `CL` (Chile), `MX` (México) y `BR` (Brasil). El país determina qué medios de pago y qué productos de cobro están disponibles.
      - `internal_bank_id` string: Identificador da instituição financeira nos sistemas da Toku.
      - `issuer` string: Instituição que emite o Pix.
      - `number` string: Número da conta do pagador.
      - `pix_automatic` object: Dados da autorização do Pix Automático, quando o meio de pagamento ficou habilitado para cobranças recorrentes sem intervenção do cliente final.
      - `provider_request_id` string: Identificador com o qual o provedor reconhece a solicitação.
      - `qr_code` string: Código QR que o cliente final escaneia para pagar.
      - `redirect_url` string: Link para o qual o cliente final é redirecionado para autorizar o Pix no seu banco.
      - `tax_id` string: CPF ou CNPJ do titular da conta.
      - `total_installments` string: Quantidade de parcelas acordadas para a cobrança.
    - `provider_external_id` string: Identificador con el que el procesador reconoce el medio de pago.
    - `status` 'deleted' | 'initialized' | 'chargeable' | 'temporary_failed' | 'permanent_failed' | 'three_ds_required' | 'inscription_failed' | 'pending_activation' | 'manually_chargeable' | 'permanent_deletion_in_progress' | 'permanently_deleted' | 'finished' | 'cancelled' | 'pending_deletion', required: Estado de un medio de pago dentro de su ciclo de vida, desde que se inscribe hasta que se da de baja. Es lo que decide si se le puede cobrar. Se cobra con `chargeable` y también con `temporary_failed`: este último es un cobro que falló por una causa reintentable, así que el motor de cobranza lo sigue tomando. `permanent_failed` queda fuera, aunque la Organization puede configurar que un porcentaje de ellos se reintente igual. `manually_chargeable` solo entra cuando el cobro se dispara a mano; las corridas automáticas lo saltan. La inscripción pasa por `initialized` mientras Toku la procesa, y queda en `pending_activation` cuando terminó de su lado pero falta la confirmación del banco o del proveedor. Si la inscripción misma falla queda en `inscription_failed`, que ya no vuelve a ser cobrable. La baja tiene dos caminos. El lógico conserva el historial del medio de pago: `pending_deletion` es una eliminación diferida, en espera de que terminen los cobros en curso, y `deleted` es la eliminación ya aplicada. El otro camino borra los datos de la tarjeta en el proveedor al cumplirse el plazo de retención, y avanza de `permanent_deletion_in_progress` a `permanently_deleted` cuando el borrado queda confirmado. `finished` y `cancelled` cierran los cobros recurrentes de Pix en Brasil: el primero es que la serie de cobros se completó y el segundo que se canceló antes de completarse. `three_ds_required` es un estado heredado que ya no se usa.
    - `status_history` StatusHistory[]: Cambios de estado por los que pasó el medio de pago, en el orden en que ocurrieron.
      - `new_status` string, required: Estado al que pasó el objeto.
      - `old_status` string: Estado en el que estaba el objeto antes del cambio. Es nulo en el primer registro.
      - `timestamp` string, date-time, required: Fecha y hora en que ocurrió el cambio de estado.
    - `toku_response_code` string: Código con el que Toku resume cómo terminó la última inscripción del medio de pago. Es nulo cuando la inscripción no dejó un código, por ejemplo en medios cargados masivamente o migrados.
    - `type` 'card' | 'bank_account' | 'pix' | 'boleto', required: Clase de medio de pago inscrito, que determina qué datos trae el PaymentMethod: `card` una tarjeta, `bank_account` una cuenta bancaria, `pix` una clave Pix y `boleto` un boleto recurrente de Brasil. Cada valor corresponde a una forma distinta del objeto, así que conviene leer el tipo antes que sus campos.
  - `product_ids` string[], required
  - `subscription_ids` string[], required
  - `updated_fields` UpdatedFields: Payload tipado del diff del webhook [``payment_method.updated``](/reference/payment-method-updated). Todos los campos son opcionales — un campo solo está presente cuando efectivamente cambió en la llamada a ``update_payment_method`` que originó el evento. ``DTOUpdatedFieldsV1()`` con todo en ``None`` se serializa como ``{"dto_version": "v1"}`` (con ``exclude_none=True``), por lo que un diff vacío igual produce una forma determinista.
    - `additional` object
    - `appended_subscriptions` SubscriptionRef[]
      - `product_id` string, required
      - `subscription_id` string, required
    - `removed_subscriptions` SubscriptionRef[]
      - `product_id` string, required
      - `subscription_id` string, required
    - `status` 'deleted' | 'initialized' | 'chargeable' | 'temporary_failed' | 'permanent_failed' | 'three_ds_required' | 'inscription_failed' | 'pending_activation' | 'manually_chargeable' | 'permanent_deletion_in_progress' | 'permanently_deleted' | 'finished' | 'cancelled' | 'pending_deletion': Estado de un medio de pago dentro de su ciclo de vida, desde que se inscribe hasta que se da de baja. Es lo que decide si se le puede cobrar. Se cobra con `chargeable` y también con `temporary_failed`: este último es un cobro que falló por una causa reintentable, así que el motor de cobranza lo sigue tomando. `permanent_failed` queda fuera, aunque la Organization puede configurar que un porcentaje de ellos se reintente igual. `manually_chargeable` solo entra cuando el cobro se dispara a mano; las corridas automáticas lo saltan. La inscripción pasa por `initialized` mientras Toku la procesa, y queda en `pending_activation` cuando terminó de su lado pero falta la confirmación del banco o del proveedor. Si la inscripción misma falla queda en `inscription_failed`, que ya no vuelve a ser cobrable. La baja tiene dos caminos. El lógico conserva el historial del medio de pago: `pending_deletion` es una eliminación diferida, en espera de que terminen los cobros en curso, y `deleted` es la eliminación ya aplicada. El otro camino borra los datos de la tarjeta en el proveedor al cumplirse el plazo de retención, y avanza de `permanent_deletion_in_progress` a `permanently_deleted` cuando el borrado queda confirmado. `finished` y `cancelled` cierran los cobros recurrentes de Pix en Brasil: el primero es que la serie de cobros se completó y el segundo que se canceló antes de completarse. `three_ds_required` es un estado heredado que ya no se usa.

## Other responses

- `400`: No se envió `id` ni `external_id`.
- `404`: No existe un Payment Method que coincida con el identificador enviado.
- `422`: Validation Error

## Changes

- **2026-11-03** `a6ef070075b1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/trytoku/apis/toku-api/changes/payment_method/get.md)

---

[API](https://skmtc.dev/trytoku/apis/toku-api.md) - [All operations](https://skmtc.dev/trytoku/apis/toku-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trytoku/apis/toku-api/revisions/a6ef070075b1?raw)