31 - Consultar Recorrência por QR Code

Consulta a autorização de recorrência por código de consulta do QR Code

curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.dev.br/api/QRCode/Consulta/{codigoQrCode}/Recorrencia \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.ext.pix.dbs.moneyp.dev.br/api/QRCode/Consulta/{codigoQrCode}/Recorrencia"

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/QRCode/Consulta/{codigoQrCode}/Recorrencia', 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/QRCode/Consulta/{codigoQrCode}/Recorrencia",
  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/QRCode/Consulta/{codigoQrCode}/Recorrencia"

	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/QRCode/Consulta/{codigoQrCode}/Recorrencia")

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

{
  "recebedor": {
    "nome": "<string>",
    "documento": "<string>"
  },
  "devedor": {
    "nome": "<string>",
    "documento": "<string>"
  },
  "contrato": {
    "descricao": "<string>",
    "numero": "<string>"
  },
  "primeiroPagamento": "2023-11-07T05:31:56Z",
  "frequenciaRecorrencia": 1,
  "descricaoRecorrencia": "<string>",
  "prazoAutorizacao": "2023-11-07T05:31:56Z",
  "valorMinimo": 123,
  "idRecorrencia": "<string>",
  "permitePagamentoPosVencimento": true,
  "valorPagamento": 123
}

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

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

Consulta a autorização de recorrência por código de consulta do QR Code

curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.dev.br/api/QRCode/Consulta/{codigoQrCode}/Recorrencia \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.ext.pix.dbs.moneyp.dev.br/api/QRCode/Consulta/{codigoQrCode}/Recorrencia"

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/QRCode/Consulta/{codigoQrCode}/Recorrencia', 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/QRCode/Consulta/{codigoQrCode}/Recorrencia",
  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/QRCode/Consulta/{codigoQrCode}/Recorrencia"

	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/QRCode/Consulta/{codigoQrCode}/Recorrencia")

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

{
  "recebedor": {
    "nome": "<string>",
    "documento": "<string>"
  },
  "devedor": {
    "nome": "<string>",
    "documento": "<string>"
  },
  "contrato": {
    "descricao": "<string>",
    "numero": "<string>"
  },
  "primeiroPagamento": "2023-11-07T05:31:56Z",
  "frequenciaRecorrencia": 1,
  "descricaoRecorrencia": "<string>",
  "prazoAutorizacao": "2023-11-07T05:31:56Z",
  "valorMinimo": 123,
  "idRecorrencia": "<string>",
  "permitePagamentoPosVencimento": true,
  "valorPagamento": 123
}

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

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

Autorizações

Authorization

string

header

obrigatório

Copie 'Bearer ' + token

Parâmetros de caminho

codigoQrCode

string<uuid>

obrigatório

Código de consulta (UUID) do QR Code de recorrência, retornado na leitura do QR Code.

Resposta

Success

recebedor

object | null

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

Show child attributes

devedor

object | null

Dados do devedor.

Show child attributes

contrato

object | null

Dados do contrato vinculado à recorrência.

Show child attributes

primeiroPagamento

string<date-time> | null

Data do primeiro pagamento da recorrência.

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

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.

idRecorrencia

string | null

Identificador da recorrência no SPI (idRec).

permitePagamentoPosVencimento

boolean

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

valorPagamento

number<double> | null

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

Guia Inicial

Guia do Desenvolvedor

Referências de API

Layouts de CNAB

31 - Consultar Recorrência por QR Code

Autorizações

Parâmetros de caminho

Resposta