Registrar Solicitação de Autorização no PSP Pagador

Os clietes devem construir esta API do lado deles para que enviemos os dados para que eles possam ser notificados. O Request é o que enviamos e a Response é o que o cliente deve nos devolver

post

Body

idReqJdPistringRequired

Identificador da requisição no JDPI

Example: 69F963C6-7487-4363-9406-A1DE2A9636D4

idRecorrenciastringRequired

dentificador único da recorrência para os pagamentos periódicos

Example: RR0435879820240605njua7shf40o

jornadanumber · enumRequired

Código da Jornada. Domínio: JORNADA_1, JORNADA_2, JORNADA_3, JORNADA_4

Default: 1Example: 1Possible values:

tpFrequencianumber · enumRequired

Código da Frequência. Domínio: 0-SEMANAL, 1-MENSAL, 2-TRIMESTRAL, 3-SEMESTRAL, 4-ANUAL

Default: 1Example: 0Possible values:

dtInicialRecorrenciastring · max: 10Required

Data prevista do primeiro pagamento. Formato: aaaa-mm-dd

Example: 2023-01-01

dtFinalRecorrenciastring | nullableRequired

Data prevista do último pagamento. Formato: aaaa-mm-dd

Example: 2025-01-01

valorobject | nullableRequired

Valor dos pagamentos.

Example: 100.00

pisoValorMaximostring | nullableRequired

Valor definido pelo usuário recebedor como piso.

Example: 150.00

recebedorall ofRequired

Grupo de informações do Recebedor

pagadorall ofRequired

Grupo de informações do Pagador

devedorall ofRequired

Grupo de informações do Pagador

nrContratostringRequired

Número, identificador, ou código que representa o objeto da autorização (contrato, pedido, etc).

Example: 12345678901234567890123456789012345

descContratostring | nullableRequired

Campo de texto livre para informações referentes ao contrato que permitam ao usuário pagador reconhecer o objeto dos pagamentos periódicos por meio do Pix Automático.

Example: Contrato de Prestacao de Servicos

dtHrCriacaoRecorrenciastringRequired

Data e hora da criação da recorrência para os pagamentos periódicos. Formato: aaaa-mm-ddTHH:mm:ss.sssZ

Example: 2023-01-01T00:00:00.000Z

dtHrCriacaoSolicitacaostring | nullableRequired

Data e hora de criação da solicitação de confirmação da autorização da recorrência para os pagamentos periódicos. Formato: aaaa-mm-ddTHH:mm:ss.sssZ

Example: 2023-01-01T00:00:00.000Z

dtHrExpiracaoSolicitacaostringRequired

Data e hora de expiração da solicitação de confirmação da recorrência para os pagamentos periódicos. Formato: aaaa-mm-ddTHH:mm:ss.sssZ. Regra de preenchimento: Deve ser preenchida no máximo, 30 dias corridos a partir da "dtHrCriacaoSolicitacao".

Example: 2023-01-31T00:00:00.000Z

Responses

default

application/json

post

HTTPcURLJavaScriptPython

POST /psti/notificar-autorizacao-pagador HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 782

{
  "idReqJdPi": "69F963C6-7487-4363-9406-A1DE2A9636D4",
  "idRecorrencia": "RR0435879820240605njua7shf40o",
  "jornada": 1,
  "tpFrequencia": 0,
  "dtInicialRecorrencia": "2023-01-01",
  "dtFinalRecorrencia": "2025-01-01",
  "valor": "100.00",
  "pisoValorMaximo": "150.00",
  "recebedor": {
    "ispb": 12345678,
    "cnpj": 61695227000193,
    "nome": "Enel"
  },
  "pagador": {
    "ispb": 12345678,
    "tpPessoa": 0,
    "cpfCnpj": 12345678901,
    "nrAgencia": "0001",
    "nrConta": "12345678901234567890",
    "codMunIbge": 1234567
  },
  "devedor": {
    "ispb": 12345678,
    "nome": "Enel",
    "tpPessoa": 0,
    "cpfCnpj": 12345678901
  },
  "nrContrato": "12345678901234567890123456789012345",
  "descContrato": "Contrato de Prestacao de Servicos",
  "dtHrCriacaoRecorrencia": "2023-01-01T00:00:00.000Z",
  "dtHrCriacaoSolicitacao": "2023-01-01T00:00:00.000Z",
  "dtHrExpiracaoSolicitacao": "2023-01-31T00:00:00.000Z"
}

default

{
  "idReqJdPi": "45F763C6-7487-4363-9406-A1DE2A9636D3",
  "idSgct": "69F963C6-7487-4363-9406-A1DE2A9636D4",
  "dtHrSgct": "2023-01-01T00:00:00.000Z"
}