34 - Consultar Autorização de Recorrência

Consulta uma autorização de recorrência

curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recebedor": {
    "nome": "<string>",
    "documento": "<string>"
  },
  "devedor": {
    "nome": "<string>",
    "documento": "<string>"
  },
  "contrato": {
    "descricao": "<string>",
    "numero": "<string>"
  },
  "primeiroPagamento": "2023-11-07T05:31:56Z",
  "tipoRecorrencia": 1,
  "descricaoRecorrencia": "<string>",
  "prazoAutorizacao": "2023-11-07T05:31:56Z",
  "valorMinimo": 123,
  "valorMaximo": 123,
  "permitePagamentoPosVencimento": true,
  "idRecorrencia": "<string>",
  "situacaoRecorrencia": 0,
  "valorPagamento": 123,
  "notificarAgendamento": true,
  "codigoConta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "frequenciaRecorrencia": 1,
  "tipoJornada": 1,
  "motivoRejeicao": 1,
  "motivoCancelamento": 1,
  "dtCancelamento": "2023-11-07T05:31:56Z"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

Consulta uma autorização de recorrência

curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ext.pix.dbs.moneyp.dev.br/api/v1/pix-automatico/autorizacoes-recorrencias/{codigoAutorizacaoRecorrencia}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recebedor": {
    "nome": "<string>",
    "documento": "<string>"
  },
  "devedor": {
    "nome": "<string>",
    "documento": "<string>"
  },
  "contrato": {
    "descricao": "<string>",
    "numero": "<string>"
  },
  "primeiroPagamento": "2023-11-07T05:31:56Z",
  "tipoRecorrencia": 1,
  "descricaoRecorrencia": "<string>",
  "prazoAutorizacao": "2023-11-07T05:31:56Z",
  "valorMinimo": 123,
  "valorMaximo": 123,
  "permitePagamentoPosVencimento": true,
  "idRecorrencia": "<string>",
  "situacaoRecorrencia": 0,
  "valorPagamento": 123,
  "notificarAgendamento": true,
  "codigoConta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "frequenciaRecorrencia": 1,
  "tipoJornada": 1,
  "motivoRejeicao": 1,
  "motivoCancelamento": 1,
  "dtCancelamento": "2023-11-07T05:31:56Z"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

{
  "sucesso": true,
  "mensagem": "<string>"
}

Autorizações

Authorization

string

header

obrigatório

Copie 'Bearer ' + token

Parâmetros de caminho

codigoAutorizacaoRecorrencia

string<uuid>

obrigatório

Código identificador (UUID) da autorização de recorrência.

Resposta

Success

codigo

string<uuid>

Código identificador da autorização de recorrência.

recebedor

object

Dados do recebedor (usuário recebedor da recorrência).

Show child attributes

devedor

object

Dados do devedor.

Show child attributes

contrato

object

Dados do contrato vinculado à recorrência.

Show child attributes

primeiroPagamento

string<date-time> | null

Data do primeiro pagamento da recorrência.

tipoRecorrencia

enum<integer>

Tipo da recorrência.

Valores: 1 - Recorrente

Opções disponíveis:

1

descricaoRecorrencia

string | null

Descrição da periodicidade da recorrência.

prazoAutorizacao

string<date-time> | null

Data limite para o pagador confirmar a autorização da recorrência.

valorMinimo

number<double> | null

Valor mínimo definido pelo recebedor para as cobranças.

valorMaximo

number<double> | null

Valor máximo autorizado pelo pagador para cada cobrança.

permitePagamentoPosVencimento

boolean

Indica se a recorrência permite pagamento após o vencimento.

idRecorrencia

string | null

Identificador da recorrência no SPI (idRec).

situacaoRecorrencia

enum<integer>

Situação da autorização de recorrência.

Valores: 0 - PendenteConfirmacao 1 - ConfirmadaPagador 2 - Cancelada 3 - AguardandoConfirmacao 4 - AguardandoCancelamento

Opções disponíveis:

0,

1,

2,

3,

4

valorPagamento

number<double> | null

Valor fixo de cada cobrança, quando definido pelo recebedor.

notificarAgendamento

boolean

Indica se o pagador será notificado sobre os agendamentos da recorrência.

codigoConta

string<uuid> | null

Código identificador da conta do pagador.

frequenciaRecorrencia

enum<integer> | null

Periodicidade das cobranças.

Valores: 1 - Semanal 2 - Mensal 3 - Trimestral 4 - Semestral 5 - Anual

Opções disponíveis:

1,

2,

3,

4,

5

tipoJornada

enum<integer>

Jornada pela qual a autorização foi criada.

Valores: 1 - SemQrCode 2 - QrCodeRecorrencia 3 - QrCodeRecorrenciaImediato 4 - QrCodeOfertaRecorrencia

Opções disponíveis:

1,

2,

3,

4

motivoRejeicao

enum<integer> | null

Motivo da rejeição da autorização, quando rejeitada.

Valores: 1 - AC01 - NumeroContaIncorreta 2 - AC04 - NumeroContaEncerrada 3 - AC06 - ContaBloqueada 4 - AG12 - TransferenciaNaoPermitida 5 - AM05 - Duplicidade 6 - AP01 - DataHoraProcessamentoIncorreta 7 - AP02 - IdentificacaoDevedorIncorreta 8 - AP03 - EmissorContaDevedorIncorreto 9 - AP04 - IdRecorrenciaIncorreto 10 - AP05 - StatusRecorrenciaIncorreto 11 - AP06 - IdentificacaoCredorIncorreta 12 - AP07 - SolicitacaoExpirada 13 - AP08 - PagamentoInstantaneoAssociadoNaoLiquidado 14 - AP09 - SolicitacaoNaoIdentificada 15 - AP10 - IniciadorIncorreto 16 - AP11 - AgenteDevedorIncorreto 17 - AP12 - AgenteCredorIncorreto 18 - AP13 - NaoReconhecidoPeloDevedor 19 - AP14 - RejeitadoPeloDevedor 20 - AP15 - NaoOferecido 21 - CH16 - ConteudoElementoFormalmenteIncorreto 22 - DS27 - UsuarioAindaNaoAtivado 23 - MD01 - SemRecorrencia 24 - MD20 - RecorrenciaExpirada 25 - RC09 - IdentificadorSistemaCompensacaoDevedorInvalido 26 - RC10 - IdentificadorSistemaCompensacaoCredorInvalido

Opções disponíveis:

1,

2,

3,

4,

5,

6,

7,

8,

9,

10,

11,

12,

13,

14,

15,

16,

17,

18,

19,

20,

21,

22,

23,

24,

25,

26

motivoCancelamento

enum<integer> | null

Motivo do cancelamento da autorização, quando cancelada.

Valores: 1 - ACCL - EncerramentoConta 2 - CPCL - EncerramentoEmpresa 3 - DCSD - Falecimento 4 - ERSL - ErroSolicitacaoConfirmacao 5 - FRUD - Fraude 6 - NRES - ExpiracaoConfirmacao 7 - PCFD - ConfirmacaoJaRealizada 8 - SLCR - SolicitadoRecebedor 9 - SLDB - SolicitadoPagador

Opções disponíveis:

1,

2,

3,

4,

5,

6,

7,

8,

9

dtCancelamento

string<date-time> | null

Data do cancelamento da autorização.

Guia Inicial

Guia do Desenvolvedor

Referências de API

Layouts de CNAB

34 - Consultar Autorização de Recorrência

Autorizações

Parâmetros de caminho

Resposta