Editar un Payment Method
Actualiza los datos de un Payment Method y devuelve cómo quedó.
Sólo se aplican los campos que vengan con valor en el cuerpo; el resto queda como estaba. Para eliminar un medio de pago hay que usar la operación de eliminación, no este endpoint.
Además de los campos comunes, la respuesta incluye los campos propios del producto del medio de pago.
Request
- Base URLhttps://api.trytoku.com
- URLhttps://api.trytoku.com/payment_methods/{id_payment_method}
- AuthAPI key in header x-api-key
Path parameters
Identificador del Payment Method que se edita.
Request body
Si el medio de pago se excluye del motor de cobro recurrente.
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 del payment method
ID de la account
ID del customer
Qué deudas puede pagar un medio de pago.
SUBSCRIPTION lo ata a las Subscriptions con las que se inscribió y solo paga deudas de esas Subscriptions. CUSTOMER lo ata al Customer y paga cualquier deuda suya, venga de la Subscription que venga.
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.
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.
Response
Payment Method actualizado. Además de los campos comunes documentados acá, el cuerpo trae los campos propios del producto del medio de pago.
Si el medio de pago se excluye del motor de cobro recurrente.
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 del payment method
ID de la account
ID del customer
Qué deudas puede pagar un medio de pago.
SUBSCRIPTION lo ata a las Subscriptions con las que se inscribió y solo paga deudas de esas Subscriptions. CUSTOMER lo ata al Customer y paga cualquier deuda suya, venga de la Subscription que venga.
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.
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.
Changes
No recorded changes to this operation across all 2 revisions of this API.