TRtrytoku
Pix

Cadastrar chave Pix

Changed on

Cadastra uma chave Pix para um Customer e devolve o Payment Method resultante.

post/brazil/pix_banking/onetime/initialize-enrollment

Request

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

Request body

external_idstring required

Identificador da chave no seu sistema. Serve para reaproveitar uma chave já cadastrada.

gatewaystring required

PSP em que a chave Pix será criada.

id_accountstring required

Identificador da Account que recebe os pagamentos feitos na chave.

id_customerstring required

Identificador do Customer a quem a chave Pix pertence.

id_subscriptionstring required

Identificador da Subscription à qual associar a chave. Precisa ser do Customer indicado.

is_sandboxboolean

Quando true, a chave é criada em ambiente de demonstração, sem efeito em produção.

Example request

{
  "id_account": "acc__ZhE-DRnJa67LOmGZOWFN-vUcQQn50o0",
  "id_customer": "cus_5FLqIhR1G5SzTZUXuisNM3WpViumkr5-",
  "id_subscription": "sub_N06VjCy3ZPfCxjFJdaspyTlEaWj8utP-"
}

Response

Successful Response

id_payment_methodstring required

Identificador do Payment Method que representa a chave Pix cadastrada.

Example response

{
  "id_payment_method": "pm_i7llS76GQXTTrbIVDsXo6vy4IA0W2MUr"
}

Changes