Listar Payment Methods
Changed onDevuelve los Payment Methods de la organización autenticada, paginados y filtrados por los query params que se envíen.
Cada elemento llega en la forma agregada del Payment Method: el medio de pago, su Customer, los product_id y las Subscriptions asociadas. El header x-api-version selecciona la versión de esa forma.
total_results cuenta todos los Payment Methods que cumplen los filtros, no solo los de la página devuelta. El listado no incluye los Payment Methods eliminados. Un Payment Method cuya forma agregada no se pueda construir queda fuera de la página, aunque total_results lo siga contando.
Request
- Base URLhttps://api.trytoku.com
- URLhttps://api.trytoku.com/payment-methods
- AuthAPI key in header x-api-key
Query parameters
Cantidad de Payment Methods por página.
Página a devolver, partiendo de 1.
Devuelve solo los Payment Methods de este Customer.
Devuelve solo los Payment Methods de esta Account.
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.
Devuelve solo los Payment Methods en este estado.
Devuelve solo los Payment Methods inscritos a través de este gateway.
Devuelve solo los Payment Methods inscritos con este toku_product.
Devuelve solo los Payment Methods con este external_id, el identificador del medio de pago en el sistema de la Organization.
Devuelve solo los Payment Methods inscritos desde esta fecha. Acepta YYYY-MM-DD, YYYY-MM-DD HH:MM:SS o YYYY-MM-DDTHH:MM:SS.
Devuelve solo los Payment Methods inscritos hasta esta fecha. Acepta los mismos formatos que start_date; cuando se envía solo la fecha, el día indicado queda incluido.
Headers
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.
Llave de API de una Account, para operar sobre esa Account en lugar de la principal.
Response
Successful Response
Changes
- breaking
for the
queryrequest parameterpage_size, default value was changed from10to50 - breaking
the response's body type changed from
arraytoobjectfor status - warning
for the
queryrequest parameterpage_size, the max was set to100.00 - warning
for the
queryrequest parameterpage, the min was set to1.00 - warning
for the
queryrequest parameterpage_size, the min was set to1.00 - info
api operation id
list-all-payment-methods-1removed and replaced withget_payment_methods - info
api tag
Payment Methodsadded - info
added the new optional
headerrequest parameterx-account-key - info
added the new optional
queryrequest parameterexternal_id - info
the
queryrequest parameterpagebecame optional - info
for the
queryrequest parameterend_date, the format was generalized fromdatetodate-time - info
for the
queryrequest parameterpage, the format was generalized fromint32to no format - info
for the
queryrequest parameterpage_size, the format was generalized fromint32to no format - info
for the
queryrequest parameterstart_date, the format was generalized fromdatetodate-time - info
for the
queryrequest parameterstatus, the type was generalized fromstringto no type - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
removed the non-success response with the status
- info
added the required property
to the response with the status - info
added the required property
to the response with the status
- breaking