--- title: "Obtener un Payment Method (ruta interna)" method: GET path: "/payment_methods/{id_payment_method}" tags: ["Payment Methods"] --- # Obtener un Payment Method (ruta interna) `GET /payment_methods/{id_payment_method}` ## Request - Base URL: `https://api.trytoku.com` - URL: `https://api.trytoku.com/payment_methods/{id_payment_method}` - Auth: API key in header `x-api-key` Devuelve un Payment Method con los datos propios de su producto. La búsqueda queda acotada a la Organization autenticada, así que un identificador de otra Organization responde como no encontrado. Cuando el medio de pago es una tarjeta, la respuesta incluye `card` con sus datos; en el resto de los productos, los datos adicionales llegan en `specific_data`. Ninguna de las dos claves aparece si el producto no aporta datos extra. ## Path parameters - `id_payment_method` string, required: Identificador del Payment Method que se consulta. ## Headers - `x-account-key` string ## Response `200` Successful Response - ExternalPaymentMethodResponse: Payment Method tal como se devuelve al consultarlo. Documenta el cuerpo que produce ``ExternalPaymentMethod.export()``, donde los identificadores salen como identificadores públicos. - `card` object: Datos de la tarjeta. Ausente cuando el medio de pago no es una tarjeta. - `engine` 'GATEWAY' | 'SAAS' | 'SAAS_UNRESTRICTED_AMOUNT' | 'SAAS_MULTIPLE_CUSTOMERS', required: Motor que ejecuta los cobros de un medio de pago. `GATEWAY` los cursa por una integración de gateway; las tres variantes `SAAS_*` corresponden a los modos en que Toku opera el cobro como servicio, y se distinguen entre sí por las restricciones de monto y de cliente del medio de pago inscrito. - `external_id` string: Identificador del medio de pago en el sistema de la Organization. - `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', required: 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 del Payment Method. - `id_account` string, required: Account a la que pertenece el Payment Method. - `id_customer` string: Customer dueño del medio de pago, si tiene uno asociado. - `specific_data` object: Datos propios del producto. Ausente cuando el producto no aporta datos adicionales. - `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. - `toku_product` 'pac_management' | 'pac_inscription' | 'direct_debit_cl' | 'direct_debit_mx' | 'transfer_cl' | 'transbank_oneclick' | 'transbank_webpay_plus' | 'klap_oneclick' | 'patpass' | 'cash' | 'cash_mx_one_time_psp' | 'cash_mx_one_time_pst' | 'cash_mx_psp' | 'cash_mx_pst' | 'toku_gateways' | 'payment_orchestration' | 'payment_orchestration_onetime' | 'multigateway_onetime' | 'toku_card_on_file' | 'toku_onetime' | 'domiciliation' | 'high_value_transfer' | 'codi' | 'wallet_mx' | 'cards_batch_mx_recurring_pst' | 'atoa_batch_mx_recurring_pst' | 'pix_onetime_pst_br' | 'boleto_br_onetime_pst' | 'boleto_br_recurring_pst' | 'pix_br_onetime_pst' | 'pix_br_onetime_psp' | 'pix_br_recurring_psp' | 'pix_bank_br_automatic_pst' | 'pix_bank_br_automatic_psp' | 'pix_bank_br_onetime_psp' | 'pix_openfinance_br_automatic_psp' | 'boleto_bank_br_onetime_psp' | 'cash_pst_cl' | 'transfer_mx_pst' | 'transfer_mx_psp' | 'transfer_cl_pst' | 'transfer_cl_psp' | 'direct_debit_onetime_cl_pst' | 'direct_debit_onetime_cl_psp' | 'bank_button_cl_pst' | 'bank_button_multiple_cl_pst' | 'bank_button_cl_psp' | 'bank_button_multiple_cl_psp' | 'digital_mandate_cl' | 'transfer_mx' | 'cards_br_recurring_pst' | 'cards_br_onetime_pst' | 'cards_br_recurring_psp' | 'cards_br_onetime_psp' | 'atoa_br_recurring_pst' | 'internal_balance' | 'cards_cl_onetime_pst' | 'cards_cl_recurring_pst' | 'cards_cl_pos_pst' | 'br_automatic_debit_pst' | 'external_collector_cl_pst' | 'referenced_payment_mx_psp' | 'in_app_payment_mx_psp' | 'external_payment' | 'collections_ai_agent' | 'bolepix_br_onetime_pst' | 'bolepix_bank_br_onetime_psp' | 'contacted_end_customers' | 'vcc' | 'atoa_batch_mx_recurring_psp' | 'international_transfer_mx_pst' | 'rat' | 'batch_reconciliations' | 'account_payouts' | 'account_payables' | 'transfer_cl_psp_wallet' | 'wallet_mx_psp', required: Producto de cobro de Toku: la combinación de método de pago, país y modalidad con que se ejecuta un cobro. El nombre codifica esas tres cosas — por ejemplo `pix_br_recurring_psp` es Pix recurrente en Brasil bajo el modelo PSP, y `cards_cl_onetime_pst` es tarjetas de un solo pago en Chile bajo el modelo PST. Es el valor que decide con qué integración se ejecuta el cobro, así que buena parte de la lógica que depende del país se resuelve a partir de él. Qué productos tiene habilitados una organización es parte de su configuración: este listado es el universo posible, no lo que una organización determinada puede cobrar hoy. `cash`, `cash_mx_one_time_psp`, `cash_mx_one_time_pst` y `transfer_mx` están deprecados y solo sobreviven por compatibilidad con registros históricos. ## Other responses - `404`: No existe un Payment Method con ese identificador en la Organization. - `422`: Validation Error --- [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)