33 - Listar Autorizações de Recorrência

Lista as autorizações de recorrência do parceiro

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

import requests

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

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', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "autorizacoes": [
    {
      "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoConta": "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",
      "prazoAutorizacao": "2023-11-07T05:31:56Z",
      "valorMinimo": 123,
      "valorMaximo": 123,
      "valorPagamento": 123,
      "permitePagamentoPosVencimento": true,
      "idRecorrencia": "<string>",
      "frequenciaRecorrencia": 1,
      "tipoJornada": 1,
      "situacaoRecorrencia": 0,
      "motivoRejeicao": 1,
      "motivoCancelamento": 1,
      "dtCancelamento": "2023-11-07T05:31:56Z"
    }
  ],
  "totalPages": 123,
  "totalRecords": 123
}

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

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

Lista as autorizações de recorrência do parceiro

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

import requests

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

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', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "autorizacoes": [
    {
      "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoConta": "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",
      "prazoAutorizacao": "2023-11-07T05:31:56Z",
      "valorMinimo": 123,
      "valorMaximo": 123,
      "valorPagamento": 123,
      "permitePagamentoPosVencimento": true,
      "idRecorrencia": "<string>",
      "frequenciaRecorrencia": 1,
      "tipoJornada": 1,
      "situacaoRecorrencia": 0,
      "motivoRejeicao": 1,
      "motivoCancelamento": 1,
      "dtCancelamento": "2023-11-07T05:31:56Z"
    }
  ],
  "totalPages": 123,
  "totalRecords": 123
}

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

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

Autorizações

Authorization

string

header

obrigatório

Copie 'Bearer ' + token

Parâmetros de consulta

Situacao

enum<integer>

Filtra pela 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

IncluirPendentes

boolean

Indica se as autorizações pendentes de confirmação devem ser incluídas na listagem.

PageSize

integer<int32>

Número de itens devolvidos por página.

Page

integer<int32>

Página que deve ser retornada.

Resposta

Success

autorizacoes

object[] | null

Lista de autorizações de recorrência da página.

Show child attributes

totalPages

integer<int32>

Quantidade total de páginas.

totalRecords

integer<int32>

Quantidade total de registros.

Guia Inicial

Guia do Desenvolvedor

Referências de API

Layouts de CNAB

33 - Listar Autorizações de Recorrência

Autorizações

Parâmetros de consulta

Resposta