v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Automatic Pix

GeneratePixAutomatic

This method can be used to initiate a Pix Automatic recurrence agreement (Jornada 1).

post/GeneratePixAutomatic

Request body

Methodstring required

Status da autorização da recorrência. 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 required

Identificador.

Retryboolean

Indica se deve tentar novamente em caso de falha. Obrigatório.

SearchProtocolinteger nullable

Protocolo único gerado após consulta de uma chave PIX. Exemplo: 5489665

Example request

{
  "Method": "GeneratePixAutomatic",
  "PartnerId": 1001,
  "BusinessUnitId": 2002,
  "Identifier": "ac1e955d-905d-436f-9881-f8dbdda58c73",
  "Retry": true,
  "Values": {
    "FinalValue": "100.00",
    "MinimumValue": "200.00"
  },
  "Receiver": {
    "TaxNumber": "12345678900",
    "Name": "João da Silva",
    "ISPB": "12345678",
    "Bank": "450",
    "BankBranch": "0001",
    "BankAccount": "440246",
    "BankAccountDigit": "3"
  },
  "Payer": {
    "TaxNumber": "12345678900",
    "Name": "João da Silva",
    "ISPB": "12345678",
    "Bank": "450",
    "BankBranch": "0001",
    "BankAccount": "440246",
    "BankAccountDigit": "3"
  },
  "Contract": {
    "Identifier": "string",
    "Description": "string"
  },
  "Date": {
    "Frequency": "Monthly",
    "InitialDate": "2025-08-25",
    "EndDate": "2025-08-25"
  },
  "SearchProtocol": 5489665
}

Response

Recorrência Pix criada com sucesso

Success'true' | 'false' required

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

Messagestring required

Mensagem de retorno da operação.

RecurrenceIdstring nullable required

Identificador da recorrência criada.

Example response

{
  "Success": "true",
  "Message": "Recorrência Pix criada com sucesso.",
  "RecurrenceId": "RN1320335420251010e50c9fe46b0"
}