v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Automatic Pix

GenerateTransactionPixAutomatic

Endpoint for sending information about a charge associated with an Automatic Pix recurrence.

post/GenerateTransactionPixAutomatic

Request body

Methodstring required

Nome do método a ser executado. Obrigatório. Erro: ISE0056 - Method não informado.

PartnerIdinteger required

Identificador do parceiro integrador. Obrigatório. Erro: ISE0057 - PartnerId não informado.

BusinessUnitIdinteger required

Identificador da unidade de negócio. Obrigatório. Erro: ISE0058 - BusinessUnitId não informado.

Identifierstring

Identificador.

RecurrenceIdstring required

Identificador da recorrência Pix. Obrigatório. Máx. 29 caracteres. Erro: EXC0034 - O campo RecurrenceId não pode conter mais que 29 caracteres.

NewAttemptboolean required

Indica se é uma nova tentativa de geração. Obrigatório.

TaxNumberstring required

CPF/CNPJ do pagador. Obrigatório. Erro: ISE0118 - É necessário informar o CPF/CNPJ.

Valuestring required

Valor da transação. Obrigatório.

Ratestring nullable

Taxa aplicada à transação. Opcional.

ChargeDatestring date required

Data de cobrança da transação. Obrigatório.

Descriptionstring nullable

Descrição da transação. Opcional.

Example request

{
  "Method": "GenerateTransactionPixAutomatic",
  "PartnerId": 30519,
  "BusinessUnitId": 51138,
  "Identifier": "ac1e955d-905d-436f-9881-f8dbdda58c73",
  "RecurrenceId": "12345678901234567890123456789",
  "NewAttempt": true,
  "TaxNumber": "12345678900",
  "Value": "10.00",
  "Rate": "0.05",
  "ChargeDate": "2025-06-26",
  "Description": "Pix recurring payment"
}

Response

Solicitação de transação realizada com sucesso

Success'true' | 'false' required

Indica se a operação foi realizada com sucesso.

Messagestring required

Mensagem de retorno da operação.

ScheduledIdstring

ID único do agendamento.

EndToEndIdstring nullable

ID de ponta a ponta da transação (disponível após a liquidação).

Example response

{
  "Success": "true",
  "Message": "Solicitação de realizado com sucesso",
  "ScheduledId": "a650a666870647449f312628cd421938",
  "EndToEndId": "E1320335420251127030075125F59207"
}