TRtrytoku
Pix

Criar cobrança Pix

Changed on

Cria uma cobrança Pix avulsa para as Invoices indicadas e devolve o QR Code e o código Copia e Cola.

post/brazil/pix_banking/onetime/external/initialize-transaction

Request

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

Request body

id_invoicesstring[] required

Identificadores das Invoices que a cobrança vai saldar. Todas precisam ser da mesma Account e do mesmo Customer.

Example request

{
  "id_invoices": [
    "in__hYAyJVJ8A1SPt1ef7Yi0bLnWMaxzWYY"
  ]
}

Response

Successful Response

copy_paste_codestring required

Código Copia e Cola do Pix, para o pagador colar no seu banco.

expiration_datestring required

Data de vencimento da cobrança, no formato dd/mm/aaaa.

id_transactionstring nullable

Identificador da Transaction criada para esta cobrança.

pix_keystring nullable

Chave Pix do recebedor em que a cobrança foi criada.

qr_code_urlstring required

Endereço da imagem do QR Code gerada pela Toku.

revisioninteger nullable

Número de revisão da cobrança no PSP.

statusstring nullable

Situação da cobrança no PSP.

txidstring nullable

Identificador da cobrança no PSP, usado para conciliar o pagamento.

Example response

{
  "id_transaction": "trs_JoESE5N-RSbAQslPGvB1Try-cb6wP5O2"
}

Changes

  • a6ef070075b1Revision changes
    • breaking

      request body became required

    • breaking

      the request property's minItems was increased to 1

    • breaking

      response property amount list-of-types was widened by adding types integer and number to media type application/json of response 200

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api operation id post_brazilboletoonetimeexternalinitialize-1 removed and replaced with external_onetime_initialize

    • info

      api tag Pix added

    • 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 non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #2 to the response property anyOf list for the response 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

      the response's property default value Invoice not found was removed for the status