Payment Methods

Actualizar Payment Method

Changed on

Actualiza un Payment Method existente.

El Payment Method se identifica con id_payment_method dentro del cuerpo de la petición. La respuesta solo confirma que la actualización se ejecutó: no devuelve el Payment Method resultante.

put/payment-methods

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/payment-methods
  • Auth
    API key in header x-api-key

Request body

asynchronousboolean
exclude_from_recurringboolean
external_idstring
force_status_changeboolean
id_bulk_insertionstring
id_customerinteger
id_payment_methodinteger required
id_subscriptionsinteger[]
only_append_subscriptionsboolean
original_response_codestring
original_response_messagestring
payment_method_dataobject
payment_scope'SUBSCRIPTION' | '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.

provider_external_idstring
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.

toku_response_codestring
unique_internal_idstring

Clave de deduplicación, para los flujos que la conocen recién al finalizar. Solo se escribe si el medio de pago todavía no tiene una y ninguna otra fila viva la ocupa.

wait_for_result_payment_instrumentboolean

Response

Successful Response

successboolean required

Es true cuando la operación se ejecutó sin errores.

Changes