TRtrytoku
Pix Automático

Cadastrar Payment Method via notificação push

Changed on

Cadastra o Payment Method de Pix Automático e cria a recorrência no banco do pagador.

post/brazil/pix_automatic/initialize-enrollment/push-notification

Request

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

Request body

agenciastring required

Agência da conta do pagador, com 4 caracteres.

bank_namestring nullable

Nome do banco do pagador, usado para resolver o ISPB quando ispb não é enviado. Precisa corresponder exatamente a um dos nomes de banco aceitos.

contastring required

Número da conta do pagador, sem pontos nem símbolos e incluindo o dígito verificador. Se o dígito verificador for X, envie 0 no lugar.

id_customerstring required

Identificador do Customer dono da conta que pagará a recorrência.

id_subscriptionstring required

Identificador da Subscription que passará a ser cobrada por Pix Automático.

ispbstring nullable

ISPB do banco do pagador, com 8 caracteres. Quando vem preenchido, tem prioridade sobre bank_name.

tipo_conta'CORRENTE' | 'POUPANCA' | 'PAGAMENTO' required

Tipo de conta bancária brasileira do pagador: CORRENTE (conta corrente), POUPANCA (conta poupança) e PAGAMENTO (conta de pagamento).

Example request

{
  "agencia": "0000",
  "bank_name": "Itaú",
  "conta": "123213",
  "id_customer": "cus_vxLdK-Grvor8vRLiZ_9LlYesHzkb6sb0",
  "id_subscription": "sub_uSikDF1U0fD6SKR46_gTUU7Pbm4Odl22",
  "ispb": "60701190"
}

Response

Successful Response

copy_paste_codestring nullable

Não é preenchido no cadastro via notificação push.

id_payment_methodstring nullable

Identificador do Payment Method criado para a Subscription.

id_transactionstring nullable

Não é preenchido no cadastro via notificação push.

metadataobject nullable

Dados adicionais devolvidos pelo banco. Com a QI Tech, traz recurrence_spi_id.

recurrence_idstring required

Identificador da recorrência criada no banco do pagador.

statusstring required

Resultado do cadastro da recorrência no banco.

txidstring nullable

Não é preenchido no cadastro via notificação push.

Example response

{
  "id_payment_method": "pm_ZOd2Ii7ROl8NmytGBhj5ob4cMcNv6bWG",
  "recurrence_id": "RR904008882025071400000000022",
  "status": "success"
}

Changes

  • a6ef070075b1Revision changes
    • breaking

      request body became required

    • breaking

      added to the request property allOf list

    • breaking

      removed the enum value Agibank of the request property

    • breaking

      removed the enum value BANCO INDUSTRIAL DO BRASIL of the request property

    • breaking

      removed the enum value BTG of the request property

    • breaking

      removed the enum value Banco Bmg S.A of the request property

    • breaking

      removed the enum value Banco Mercantil do Brasil of the request property

    • breaking

      removed the enum value Banco PAN of the request property

    • breaking

      removed the enum value Banco Sofisa S.A. of the request property

    • breaking

      removed the enum value Banco XP S.A. of the request property

    • breaking

      removed the enum value Banco de Brasilia of the request property

    • breaking

      removed the enum value Banco do Brasil of the request property

    • breaking

      removed the enum value Banco do Nordeste do Brasil S.A. of the request property

    • breaking

      removed the enum value Banestes of the request property

    • breaking

      removed the enum value Banrisul of the request property

    • breaking

      removed the enum value Bradesco of the request property

    • breaking

      removed the enum value C6 Bank of the request property

    • breaking

      removed the enum value CORRENTE of the request property

    • breaking

      removed the enum value Caixa of the request property

    • breaking

      removed the enum value Inter of the request property

    • breaking

      removed the enum value Itaú of the request property

    • breaking

      removed the enum value Iti of the request property

    • breaking

      removed the enum value Mercado Pago of the request property

    • breaking

      removed the enum value Nubank of the request property

    • breaking

      removed the enum value PAGAMENTO of the request property

    • breaking

      removed the enum value POUPANCA of the request property

    • breaking

      removed the enum value Picpay of the request property

    • breaking

      removed the enum value RecargaPay of the request property

    • breaking

      removed the enum value Rendimento of the request property

    • breaking

      removed the enum value STONE PAGAMENTOS S.A. of the request property

    • breaking

      removed the enum value Safra PF of the request property

    • breaking

      removed the enum value Santander of the request property

    • breaking

      removed the enum value Sicoob of the request property

    • breaking

      removed the enum value Sicredi of the request property

    • breaking

      removed the enum value SÃO MIGUEL DO OESTE of the request property

    • breaking

      removed the enum value Unicred of the request property

    • breaking

      removed the enum value banco Digio of the request property

    • breaking

      the request property type changed from string to no type

    • breaking

      response property detail/items/loc/items/ list-of-types was widened by adding types integer to media type application/json of response 422

    • breaking

      removed the success response with the status

    • info

      api operation id cadastro-de-pix-automático-via-notificação-push removed and replaced with initialize_push_notification_enrollment

    • info

      api tag Pix Automático added

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • 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

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      added the success response with the status