Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Authorization

Modificar Autorização de Pix Automático

API responsável por editar uma autorização de Pix Automático

patch/automatic-pix/authorization/{authorizationId}

Path parameters

authorizationIdstring uuid required

Id da autorização do Pix Automático

Example:611a3814-dc17-4d0b-b7fc-20f98ba618ee

Id da autorização

Request body

initialDatestring

Data do primeiro pagamento (deve respeitar um intervalo mínimo de 3 dias a partir da data atual)

debtorNamestring

Nome do devedor

locationIdstring
activationTxIdstring

Example request

{
  "initialDate": "2025-04-18",
  "debtorName": "Nome do devedor",
  "locationId": "b226b648-9410-42d3-88f3-497c23608a3d",
  "activationTxId": "3214"
}

Response

Autorização criada com sucesso.

authorizationIdstring uuid required

Id da autorização do Pix Automático

createdAtstring required

Data da criação

initialDatestring required

Data do primeiro pagamento (deve respeitar um intervalo mínimo de 3 dias a partir da data atual)

finalDatestring

Data prevista do último pagamento

amountnumber

Valor

retryPolicy'ACCEPT_3R_7D' | 'NOT_APPLICABLE' required

Retentativa de pagamento

period'ANNUALLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'WEEKLY' required

Período da autorização

updatedAtstring required

Data da atualização

status'PROCESSING' | 'CREATED' | 'CANCELED' | 'CANCELING' | 'EXPIRED' | 'APPROVED' | 'REJECTED' | 'FINISHED' required

Status da autorização

totalInstallmentsnumber

Total de pagamentos previstos (existirá apenas caso a autorização do Pix Automático tenha uma data final definida)

originstring required

Example response

{
  "authorizationId": "611a3814-dc17-4d0b-b7fc-20f98ba618ee",
  "createdAt": "2025-04-15T21:00:44.875Z",
  "initialDate": "2025-04-18",
  "finalDate": "2026-04-18",
  "link": {
    "rel": "self",
    "href": "/direct-debits/d2627834-dd84-4094-9dcf-ca784460b352",
    "method": "DELETE",
    "type": "application/json"
  },
  "amount": 10.23,
  "retryPolicy": "ACCEPT_3R_7D",
  "period": "ANNUALLY",
  "updatedAt": "2025-04-15T21:00:44.875Z",
  "requests": [
    {
      "requestId": "c6184dae-3f92-42ed-8b47-d9f4593ee0a5",
      "authorizationId": "611a3814-dc17-4d0b-b7fc-20f98ba618ee",
      "createdAt": "2025-04-15T21:00:44.875Z",
      "expirationDate": "2025-04-15T23:23:59.547Z",
      "origin": "WEB",
      "recipient": {
        "taxId": "37297902000141",
        "name": "W A PRODUTOS DIGITAIS LTDA",
        "personType": "J",
        "account": {
          "ispbParticipant": "00000000",
          "number": "003886850",
          "branch": "50"
        }
      },
      "status": "CREATED"
    }
  ],
  "status": "CREATED",
  "totalInstallments": 10,
  "payee": {
    "document": "00000000000125",
    "fantasyName": "VECHI CONSULTORIA E PROJETOS LTDA",
    "socialName": "VECHI CONSULTORIA E PROJETOS LTDA",
    "bankCode": "208",
    "bankName": "VECHI CONSULTORIA E PROJETOS LTDA"
  },
  "activation": {
    "journeyType": "JOURNEY_1",
    "txId": "3214"
  },
  "origin": "WEB",
  "location": {
    "id": "b226b648-9410-42d3-88f3-497c23608a3d",
    "type": "cob",
    "taxId": "30306294000145",
    "url": "https://static.uat.com/pix/dynamic/qrcode/37297902000141/4c972de4-3842-4b89-a2de-99f749a78950.png"
  },
  "qrCodeInfo": {
    "emv": "copiaecola",
    "journeyType": "JOURNEY_1"
  }
}