TRtrytoku
Payment Methods

Listar los Payment Methods de un Customer

Changed on

Lista los Payment Methods de un Customer con su estado y sus Subscriptions.

Por omisión sólo devuelve los medios de pago cobrables; los que tienen una falla transitoria se incluyen sólo si se pide explícitamente.

Los resultados vienen paginados.

get/payment-methods/customers/{customer_id}

Request

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

Path parameters

customer_idstring required

Customer cuyos medios de pago se listan.

Query parameters

include_temporary_failedboolean

Incluir también los medios de pago con una falla transitoria.

pageinteger

Página de resultados que se quiere obtener.

page_sizeinteger

Cantidad de medios de pago por página.

Headers

x-account-keystring

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Response

Successful Response

accountstring required
customerstring required
detailsobject
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.

idstring 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' 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.

subscriptionsstring[]

Changes