Débito Automático

Cadastrar Payment Methods de Débito Automático

Changed on

Cadastra, em um único lote, as contas bancárias que passarão a ser debitadas.

post/brazil/automatic-debit/payment-method

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/brazil/automatic-debit/payment-method
  • Auth
    API key in header x-api-key

Request body

bank'Banco de Brasilia' | 'Banco Santander' | 'Banco Bradesco' | 'Banco do Brasil' | 'C6 Bank' | 'Sicoob' | 'Caixa Economica Federal' | 'Banco Itau' | 'BTG Pactual'

Banco em que o pagador autorizou o débito na sua conta.

id_accountstring required

Identificador da Account dona das Subscriptions.

Example request

{
  "bank": "Banco Santander",
  "id_account": "acc_7Kq2mR4tXvB9nD1sYpL0aZcE6hJ3wF8u",
  "payment_method_data": [
    {
      "account_number": "11223344",
      "account_type": "CORRENTE",
      "address": {
        "admin_area": "SP",
        "city": "São Paulo",
        "neighborhood": "Bela Vista",
        "postal_code": "01310100",
        "street_name": "Avenida Paulista",
        "street_number": "1000"
      },
      "agency": "1122",
      "government_id": "00000000191",
      "id_subscriptions": [
        "sub_4Nv8bT2yQm6rK9xJ1eZ7dC3sW5hP0gLu"
      ],
      "requires_opt_in": false,
      "sender_bank_id": "90400888"
    }
  ]
}

Response

Successful Response

statusstring required

Rótulo do resultado da operação.

Example response

{
  "status": "created"
}

Changes

    • breaking

      request body became required

    • breaking

      added to the request property allOf list

    • breaking

      removed the enum value Banco Santander of the request property

    • breaking

      removed the enum value Banco de Brasilia of the request property

    • breaking

      removed the enum value CORRENTE 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

      the // request property's minItems was increased to 1

    • breaking

      the request property type changed from string to no type

    • breaking

      the // request property type changed from object to no type

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the success response with the status

    • warning

      the // request property's maxLength was set to 14

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • info

      api operation id post_brazil-automatic-debit-payment-method removed and replaced with create_bulk_automatic_debit_payment_methods

    • info

      api tag Débito Automático added

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added subschema #2 to the // request property anyOf list

    • info

      the request property // became optional

    • info

      the request property // became optional

    • info

      the request property default value CORRENTE was 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

      added the required property to the response with the status

    • info

      added the success response with the status