TRtrytoku
Boleto

Cadastrar Payment Method de boleto

Changed on

Cria o Payment Method de boleto que a Subscription usará para cobrar.

post/brazil/boleto/onetime/enrollment

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/brazil/boleto/onetime/enrollment
  • Auth
    API key in header x-api-key

Request body

create_custom_carteriaboolean

Quando true, abre uma carteira de cobrança própria no provedor antes de cadastrar o Payment Method.

external_idstring required

Identificador do Payment Method no sistema de quem integra.

gateway'transbank_oneclick' | 'klap_oneclick' | 'patpass' | 'toku_onetime' | 'toku_pac' | 'fintoc_pac' | 'universo_pac' | 'ecert_pac' | 'external_pac' | 'manual_pac' | 'internal_psp' | 'domiciliation' | 'mx_banco_bbva' | 'mx_banco_bancomer' | 'payment_orchestration' | 'getnet' | 'getnet_pos' | 'transbank' | 'transbank_webpay_plus' | 'khipu_transfer' | 'fintoc_transfer' | 'floid_transfer' | 'toku_transfer' | 'conciliation' | 'pb_transfer_cl_banco_de_chile' | 'pb_transfer_cl_banco_de_chile-evertec' | 'pb_transfer_cl_banco_santander' | 'pb_transfer_cl_banco_santander-evertec' | 'pb_transfer_cl_banco_santander_direct' | 'pb_transfer_cl_banco_santander-native' | 'pb_transfer_cl_banco_scotiabank' | 'pb_transfer_cl_banco_scotiabank_direct' | 'pb_transfer_cl_banco_scotiabank-native' | 'pb_transfer_cl_banco_bci' | 'pb_transfer_cl_banco_bci-native' | 'pb_transfer_cl_banco_bci_direct' | 'pb_transfer_cl_banco_bci-serviex' | 'pb_transfer_cl_banco_itau' | 'pb_transfer_cl_banco_itau-evertec' | 'pb_transfer_cl_banco_estado' | 'pb_transfer_cl_banco_bice' | 'pb_transfer_cl_banco_falabella' | 'arcus_transfer' | 'stp_transfer' | 'cobre_transfer' | 'monex_transfer' | 'oxxo' | 'paycash' | 'dapp' | 'tapi' | 'puntored' | 'cash_pickup' | 'multigateway_onetime' | 'toku_gateways_conekta' | 'toku_gateways_stripe' | 'toku_gateways_mercado_pago' | 'toku_gateways_open_pay' | 'toku_gateways_pay_u' | 'toku_gateways_paypal' | 'toku_gateways_net_pay' | 'po_open_pay' | 'po_rapyd' | 'po_conekta' | 'po_stripe' | 'po_kushki' | 'po_fiserv' | 'po_evo_payments' | 'po_paypal' | 'po_mit' | 'openpay' | 'rapyd' | 'conekta' | 'stripe' | 'kushki' | 'mit' | 'codi_qr' | 'codi' | 'paypal' | 'br_banco_itau' | 'br_banco_itau_boleto' | 'br_banco_bradesco_boleto' | 'br_banco_bradesco_pix' | 'br_sicredi_boleto' | 'servipag' | 'servipag_portal' | 'servipag_caja_presencial' | 'servipag_caja_express' | 'cards_batch_mx_recurring_pst' | 'amex_batch_mx_recurring_pst' | 'braintree' | 'pagarme' | 'br_paulista_servicios_automatic_debit' | 'mx_banco_santander' | 'mx_banco_bbva_bancomer' | 'mx_banco_banorte' | 'mx_banco_banorte_h2h' | 'mx_banco_scotiabank' | 'mx_banco_hsbc' | 'mx_banco_citibanamex' | 'mx_banco_multiva' | 'mx_amex' | 'mx_banco_banbajio' | 'mx_banco_banregio' | 'mx_banco_sabadell' | 'mx_belvo' | 'mx_bbva_cie' | 'internal_balance' | 'fiserv' | 'cielo' | 'belvo' | 'mx_banco_scotiabank_h2h_external' | 'iniciador' | 'qi_tech' | 'evo_payments' | 'cl_banco_de_chile' | 'cl_banco_bci' | 'cl_banco_santander' | 'cl_banco_scotiabank' | 'cl_banco_security' | 'cl_banco_consorcio_fidi' | 'transdata' | 'br_banco_do_brasil' | 'br_banco_santander' | 'br_banco_citibank' | 'rede' | 'mercadopago' | 'br_caixa_via_accesstage' | 'br_banco_de_brasilia' | 'worldpay' | '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_itau_via_accesstage' | 'external_payment' | 'br_sicoob' | 'br_caixa' | 'br_btg' | 'toku_mx_belvo' | 'toku_mx_banco_bbva_bancomer' | 'servipag_button' | 'servipag_cashier' | 'servipag_web' | 'servipag_express' | 'sencillito_cashier' | 'sencillito_web' | 'scotiabank_cashier' | 'unired' required

Integración por la que se cursa un intento de cobro: el adquirente, banco o recaudador concreto que lo ejecuta. La mayoría de los valores corresponde a una institución de un solo país; el resto son mecanismos propios de Toku, como internal_psp, manual_pac o external_payment.

Es el conjunto más amplio de gateways de Toku y crece cada vez que se habilita una institución nueva, así que conviene leerlo como una lista abierta y no agotar sus valores en el código. Para el gateway con que se inscribió un medio de pago, ver PaymentMethodGateway.

id_accountstring required

Identificador da Account que cobra por boleto.

id_customerstring required

Identificador do Customer que pagará o boleto.

id_subscriptionstring required

Identificador da Subscription à qual o Payment Method será associado.

is_sandboxboolean

Quando true, a carteira é aberta no ambiente de testes do provedor.

Example request

{
  "id_account": "acc_rdpuAKbkQxQvqNNfH3aSBqp_vo5YSXfB",
  "id_customer": "cus_fr1aLmmbsKCrIBiXpMxxRogxrm5gP4yV",
  "id_subscription": "sub_CDsHIJEqhCB8fvVbEJDUDSusFgcHdji_"
}

Response

Successful Response

id_payment_methodstring required

Identificador do Payment Method criado.

Example response

{
  "id_payment_method": "pm_H6MwwkdqxvVZyuYUIBOjUsycWnk4hSWE"
}

Changes