Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Authorization

Criar Agendamento de Cobrança para Pix Automático

API responsável por criar agendamento de uma cobrança de Pix Automático

post/automatic-pix/authorization/{authorizationId}/scheduling-instruction

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

scheduledDatestring required

Data do agendamento (respeitar a antecedência de 3 a 10 dias em relação à data prevista para a liquidação)

amountnumber required

Valor

additionalInformationstring

Descrição do agendamento

txIdstring

Example request

{
  "scheduledDate": "2025-04-15",
  "amount": 10.23,
  "additionalInformation": "Descrição do agendamento",
  "txId": "3214"
}

Response

Agendamento criado com sucesso.

idstring uuid required

Id do agendamento

authorizationIdstring uuid required

Id da autorização do Pix Automático

createdAtstring required

Data da criação

installmentNumbernumber

Número da parcela (existirá apenas caso a autorização do Pix Automático tenha uma data final definida)

scheduledDatestring required

Data do agendamento (respeitar a antecedência de 3 a 10 dias em relação à data prevista para a liquidação)

amountnumber required

Valor

additionalInformationstring

Descrição do agendamento

updatedAtstring

Data da atualização

status'WAITING_SCHEDULING' | 'SENT_SCHEDULING' | 'CONFIRMED' | 'PAID' | 'CANCELED' | 'CANCELING' | 'REJECTED' | 'EXPIRED' | 'FAILED' required

Status do agendamento

periodInitialDatestring

Data início do ciclo

periodFinalDatestring

Data final do ciclo

originstring required
canceledAtstring

Data de cancelamento

cancellationCode'ACCT' | 'BLCK' | 'CCLD' | 'FAIL' | 'OTHR' | 'SLBD' | 'SLCR'

Scheduling Instruction Cancellation Code:

  • ACCT: Encerramento da conta transacional do usuário pagador ou do usuário recebedor
  • BLCK: Bloqueio da conta transacional do usuário pagador ou do usuário recebedor
  • CCLD: Autorização cancelada
  • FAIL: Falha no fluxo de liquidação
  • OTHR: Solicitado pela instituição financeira do pagador ou recebedor
  • SLBD: Solicitado pelo usuário pagador
  • SLCR: Solicitado pelo usuário recebedor
cancellationDescriptionstring
settledAtstring

Data da liquidação

paidAtstring

Data do pagamento

rejectedAtstring

Data da rejeição

rejectionCode'AB10' | 'AC05' | 'AC06' | 'AG12' | 'AM02' | 'AM09' | 'DENC' | 'DS27' | 'DTED' | 'DTNT' | 'FBRD' | 'IRNT' | 'MIDI' | 'MSUC' | 'NIEC' | 'NIPA' | 'NITX' | 'QUNT' | 'RC09' | 'UDEI' | 'PRJL' | 'FF08' | 'CRNC' | 'CH16'

Scheduling Instruction Rejection Code:

  • AB10: Transação interrompida devido a um erro na instituição financeira do usuário pagador
  • AC05: A conta transacional do usuário pagador foi encerrada
  • AC06: A conta transacional do usuário pagador está bloqueada
  • AG12: A solicitação de agendamento não é permitida de uma conta transacional para outra dentro da mesma instituição financeira
  • AM02: O valor cobrado excede o valor máximo definido pelo usuário pagador
  • AM09: O valor cobrado não corresponde ao valor definido na autorização do Pix Automático
  • DENC: O número do documento do usuário pagador não corresponde aos dados contidos na autorização do Pix Automático
  • DS27: A instituição financeira não está registrado ou ainda não iniciou as operações no SPI
  • DTED: A data de agendamento não corresponde à frequência da autorização do Pix Automático com base na última programação e/ou regras do produto
  • DTNT: Não são permitidas novas tentativas de agendamento após a data de vencimento além do limite da regra de negócios
  • FBRD: Solicitação de agendamento recebida após o prazo para cumprimento das regras comerciais
  • IRNT: Essa autorização de Pix Automático não permite novas tentativas de agendamento após o vencimento
  • MIDI: O ID da autorização de Pix Automático informado não existe ou está incorreto
  • MSUC: Agendamento rejeitado pois a autorização do Pix Automático não está aprovada
  • NIEC: A nova instrução de agendamento é inválida porque a mesma cobrança já possui um agendamento em aberto
  • NIPA: A nova instrução de agendamento é inválida, o agendamento já foi feito
  • NITX: A nova instrução de agendamento não corresponde a uma autorização de Pix Automático
  • QUNT: O número de novas tentativas de agendamento após a data de vencimento excede o limite definido pela regra de negócios
  • RC09: O número de ISPB da instituição financeira do usuário pagador é inválido ou inexistente
  • UDEI: O número do documento do devedor está incorreto
  • PRJL: Cancelamento de agendamento inválido, pois o pagamento já foi concluído com sucesso
  • FF08: O EndToEnd da transação não corresponde ao valor informado originalmente
  • CRNC: O número do documento do usuário destinatário não corresponde aos dados contidos na autorização
  • CH16: O identificador da transação não corresponde ao valor informado originalmente
rejectionDescriptionstring

Example response

{
  "id": "611a3814-dc17-4d0b-b7fc-20f98ba618ee",
  "authorizationId": "611a3814-dc17-4d0b-b7fc-20f98ba618ee",
  "createdAt": "2025-04-15T21:00:44.875Z",
  "installmentNumber": 10,
  "scheduledDate": "2025-04-15",
  "amount": 10.23,
  "additionalInformation": "Descrição do agendamento",
  "updatedAt": "2025-04-15T21:00:44.875Z",
  "status": "SENT_SCHEDULING",
  "periodInitialDate": "2025-04-18",
  "periodFinalDate": "2025-05-17",
  "payee": {
    "document": "00000000000125",
    "fantasyName": "VECHI CONSULTORIA E PROJETOS LTDA",
    "socialName": "VECHI CONSULTORIA E PROJETOS LTDA",
    "bankCode": "208",
    "bankName": "VECHI CONSULTORIA E PROJETOS LTDA"
  },
  "origin": "WEB",
  "canceledAt": "2025-04-15T21:00:44.875Z",
  "cancellationCode": "ACCT",
  "cancellationDescription": "Descrição do cancelamento",
  "settledAt": "2025-04-16T21:00:44.875Z",
  "paidAt": "2025-04-16T21:00:44.875Z",
  "rejectedAt": "2025-04-15T21:00:44.875Z",
  "rejectionCode": "AB10",
  "rejectionDescription": "Descrição da rejeição"
}