Medio de pago de un customer: tarjeta, cuenta bancaria o Pix.
Un Payment Method es la forma de pago que un Customer deja inscrita para que Toku le cobre después: una tarjeta guardada, una cuenta bancaria para PAC o domiciliación, o un Pix.
Guarda en qué estado quedó la inscripción —de eso depende que se le pueda cobrar—, con qué procesador se cursa el cobro y el detalle del medio inscrito, que viaja en card, bank_account o pix según su type. Los datos sensibles nunca viajan aquí: la tarjeta se identifica por su token y sus últimos dígitos.
Atributos
bank_account ApiPaymentMethod_DTOBankAccountPaymentMethodV1
Detalle de la cuenta bancaria. Es nulo cuando el type no es bank_account.
bank_account.account_number string
Número de la cuenta bancaria.bank_account.account_type string
Tipo de cuenta bancaria, por ejemplo corriente, vista o de ahorro.bank_account.additional_data object
Datos complementarios de la cuenta que registró la institución financiera.bank_account.bank_id string
Código de la institución financiera de la cuenta.bank_account.bank_name string
Nombre de la institución financiera de la cuenta.bank_account.institution_country string
País de la institución financiera, en formato ISO 3166-1 alfa-2.Valores posibles:
CL,MX,BR.bank_account.name string
Nombre del titular de la cuenta bancaria.
card CardPaymentMethod
Detalle de la tarjeta. Es nulo cuando el type no es card.
card.additional_data object
Datos complementarios de la tarjeta que registró el procesador.card.bank_id string
Código del banco emisor de la tarjeta.card.bank_name string
Nombre del banco emisor de la tarjeta.card.bin string
Primeros dígitos de la tarjeta, que identifican al emisor y al tipo de producto.card.card_brand string
Marca de la tarjeta, por ejemplovisaomastercard.card.card_holder string
Nombre del titular registrado en la tarjeta.card.card_type string
Tipo de tarjeta:credit,debitoprepaid.card.expiration_month string
Mes de vencimiento de la tarjeta, de01a12.card.expiration_year string
Año de vencimiento de la tarjeta.card.institution_country string
País del banco emisor de la tarjeta, en formato ISO 3166-1 alfa-2.Valores posibles:
CL,MX,BR.card.last_digits string
Últimos dígitos de la tarjeta, para que el cliente final la reconozca.card.three_d_secure boolean
Indica si la tarjeta se inscribió con autenticación 3-D Secure del emisor.card.token string
Token con el que el procesador identifica la tarjeta guardada. Reemplaza al número de tarjeta al momento de cobrar.
card_brand string
Marca de la tarjeta, por ejemplo visa o mastercard. Es nulo cuando el medio de pago no es una tarjeta.
created_at string (date-time)
Fecha y hora en que se inscribió el medio de pago.
external_id string
Identificador que entrega la organización para reconocer el medio de pago en sus propios sistemas.
gateway string
Procesador con el que se inscribió el medio de pago y con el que se cursan sus cobros.
Valores posibles: 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, ….
id string
Identificador único del Payment Method.
id_payment_instrument string
Payment Instrument al que apunta el medio de pago: la tarjeta o cuenta concreta que Toku tiene guardada y que puede compartirse entre varios medios de pago.
payment_method_metadata object
Datos propios de la organización que se guardaron junto al medio de pago.
pix PixPaymentMethod
Detalle del Pix. Es nulo cuando el type no es pix.
pix.account_type string
Tipo de conta bancária do pagador.pix.additional_data object
Dados complementares do Pix registrados pelo provedor.pix.bank_id string
Código da instituição financeira do pagador.pix.bank_name string
Nome da instituição financeira do pagador.pix.copy_paste_code string
Código copia e cola com o qual o cliente final paga pelo seu banco.pix.end_to_end_id string
Identificador com o qual o Banco Central do Brasil acompanha a transferência de ponta a ponta.pix.error_code string
Código com o qual o provedor respondeu à recusa. É nulo quando não houve recusa.pix.error_message string
Mensagem com a qual o provedor explicou a recusa. É nulo quando não houve recusa.pix.expiration_date string (date-time)
Data e hora até a qual o código de pagamento permanece válido.pix.institution_country string
País da instituição financeira, no formato ISO 3166-1 alfa-2. Sempre é o Brasil.Valores posibles:
CL,MX,BR.pix.internal_bank_id string
Identificador da instituição financeira nos sistemas da Toku.pix.issuer string
Instituição que emite o Pix.pix.number string
Número da conta do pagador.pix.pix_automatic object
Dados da autorização do Pix Automático, quando o meio de pagamento ficou habilitado para cobranças recorrentes sem intervenção do cliente final.pix.provider_request_id string
Identificador com o qual o provedor reconhece a solicitação.pix.qr_code string
Código QR que o cliente final escaneia para pagar.pix.redirect_url string
Link para o qual o cliente final é redirecionado para autorizar o Pix no seu banco.pix.tax_id string
CPF ou CNPJ do titular da conta.pix.total_installments string
Quantidade de parcelas acordadas para a cobrança.
provider_external_id string
Identificador con el que el procesador reconoce el medio de pago.
status string
Estado de la inscripción: initialized y pending_activation mientras no termina, chargeable cuando el medio quedó listo para cobrar, temporary_failed tras una falla que se puede reintentar, permanent_failed tras una que no, inscription_failed cuando la inscripción nunca se completó, y pending_deletion, deleted, cancelled o finished cuando el medio dejó de estar vigente.
Valores posibles: 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.
status_history array of StatusHistory
Cambios de estado por los que pasó el medio de pago, en el orden en que ocurrieron.
status_history[].new_status string
Estado al que pasó el objeto.status_history[].old_status string
Estado en el que estaba el objeto antes del cambio. Es nulo en el primer registro.status_history[].timestamp string (date-time)
Fecha y hora en que ocurrió el cambio de estado.
toku_response_code string
Código con el que Toku resume cómo terminó la última inscripción del medio de pago. Es nulo cuando la inscripción no dejó un código, por ejemplo en medios cargados masivamente o migrados.
type string
Tipo de medio de pago, que determina cuál de los detalles viene poblado: card trae card, bank_account trae bank_account y pix trae pix.
Valores posibles: card, bank_account, pix.
Ejemplo
{
"bank_account": {
"account_number": "string",
"account_type": "03",
"additional_data": {},
"bank_id": "string",
"bank_name": "string",
"institution_country": "CL",
"name": "string"
},
"card": {
"additional_data": {},
"bank_id": "string",
"bank_name": "string",
"bin": "string",
"card_brand": "string",
"card_holder": "string",
"card_type": "credit",
"expiration_month": "string",
"expiration_year": "string",
"institution_country": "CL",
"last_digits": "string",
"three_d_secure": false,
"token": "string"
},
"card_brand": "string",
"created_at": "2026-01-20T00:00:00Z",
"external_id": "string",
"gateway": "transbank_oneclick",
"id": "string",
"id_payment_instrument": "string",
"payment_method_metadata": {},
"pix": {
"account_type": "string",
"additional_data": {},
"bank_id": "string",
"bank_name": "string",
"copy_paste_code": "string",
"end_to_end_id": "string",
"error_code": "string",
"error_message": "string",
"expiration_date": "2026-01-20T00:00:00Z",
"institution_country": "CL",
"internal_bank_id": "string",
"issuer": "string",
"number": "string",
"pix_automatic": {},
"provider_request_id": "string",
"qr_code": "string",
"redirect_url": "string",
"tax_id": "string",
"total_installments": "string"
},
"provider_external_id": "string",
"status": "deleted",
"status_history": [
{
"new_status": "string",
"old_status": "string",
"timestamp": "2026-01-20T00:00:00Z"
}
],
"toku_response_code": "string",
"type": "card"
}