TRtrytoku
Payment Methods

Listar Payment Methods con datos del Customer

Changed on

Devuelve los Payment Methods de la organización autenticada en formato plano, con los datos del Customer y de la Subscription ya incorporados en cada elemento.

A diferencia del listado agregado de Payment Methods, cada elemento trae directamente los campos del Customer (nombre, correo, teléfono e identificador tributario), los de la tarjeta y los del mandato PAC, además de las llaves de metadata de Customer y de Subscription que la organización tenga configuradas.

No incluye los Payment Methods eliminados, ni los que tienen la inscripción en curso o fallida, ni los que están en proceso de borrado definitivo.

page_size se limita a 500 y, si se omite, se usan 10 elementos por página. Responde 404 cuando ningún Payment Method cumple los filtros.

get/organization/payment_methods

Request

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

Query parameters

pageinteger

Página a devolver, partiendo de 1.

page_sizeinteger

Cantidad de Payment Methods por página. Si se omite se usan 10 y el máximo aceptado es 500.

start_datestring date

Devuelve solo los Payment Methods inscritos desde esta fecha, en formato YYYY-MM-DD.

end_datestring date

Devuelve solo los Payment Methods inscritos antes de esta fecha, en formato YYYY-MM-DD. La fecha indicada queda excluida.

id_bulk_insertionstring

Devuelve solo los Payment Methods inscritos en esta carga masiva.

id_data_in_filestring

Devuelve solo los Payment Methods vinculados a este registro de un archivo cargado.

Headers

x-account-keystring

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

Response

Successful Response

account_namestring

Nombre de la Account bajo la que está el Payment Method.

card_bank_namestring

Banco emisor de la tarjeta inscrita.

card_brandstring

Marca de la tarjeta inscrita. Llega con valor solo en medios de pago con tarjeta.

card_numberstring

Dígitos visibles de la tarjeta inscrita, sin los caracteres de enmascaramiento. Llega con valor solo en medios de pago con tarjeta.

card_typestring

Modalidad de la tarjeta inscrita. Llega con valor solo en medios de pago con tarjeta.

created_atstring required

Fecha y hora en que se inscribió el Payment Method.

customerstring

Customer dueño del Payment Method. Llega en null cuando el medio de pago no tiene Customer asociado.

deleted_atstring

Fecha y hora de eliminación del Payment Method. En este listado siempre llega en null.

external_idstring

Identificador del Customer en el sistema de la organización.

gatewaystring

Nombre legible del producto con el que se inscribió el medio de pago.

government_idstring

Identificador tributario del Customer.

holder_namestring

Nombre del titular del mandato PAC.

idstring required

Payment Method al que corresponde el elemento.

last_payment_intent_response_codeinteger

Código con que respondió el último intento de cobro. Es null cuando no hay un intento registrado o cuando el código fue 0.

mailstring

Correo del Customer.

namestring

Nombre del Customer.

pac_account_numberstring

Número de cuenta inscrito en el mandato PAC.

pac_account_typestring

Tipo de cuenta inscrito en el mandato PAC.

pac_government_idstring

Identificador tributario del titular del mandato PAC.

pac_institution_namestring

Institución donde está inscrito el mandato PAC.

pac_mandate_idstring

Identificador del mandato PAC en la institución.

pac_voucher_urlstring

Enlace al comprobante del mandato PAC. No se incluye cuando la organización tiene los comprobantes restringidos.

phone_numberstring

Teléfono del Customer.

product_idstring

product_id de la Subscription que se cobra con este Payment Method.

statusstring

Estado del Payment Method dentro de su ciclo de vida.

tokenstring

Token con que el proveedor identifica el medio de pago inscrito.

Example response

[
  {
    "customer": "cus_Ht7Kd2vRq0XbNm4Y_3ZpLcJfW9Ee1AsU",
    "id": "pm_pBf2NL0d0gvBM7Ei_1E3HIWnTN4W93_O"
  }
]

Changes