16 - Transfer Resource

Realiza uma transferência via Pix.

curl --request POST \
  --url https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Transferir \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "dadosEnvioPorChave": {
    "ticket": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "chave": "<string>"
  },
  "dadosEnvioPorConta": {
    "contaDestino": {
      "agencia": "<string>",
      "agenciaDigito": "<string>",
      "conta": "<string>",
      "contaDigito": "<string>",
      "contaPgto": "<string>"
    },
    "ispbDestino": "<string>",
    "nomeDestino": "<string>",
    "documentoFederalDestino": "<string>"
  },
  "valor": 123,
  "codigoOperacaoCliente": "<string>",
  "descricaoCliente": "<string>",
  "contaOrigem": {
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPgto": "<string>"
  },
  "informacoesAdicionais": "<string>",
  "idConciliacaoRecebedor": "<string>",
  "codigoLeituraQRCode": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Transferir"

payload = {
    "dadosEnvioPorChave": {
        "ticket": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "chave": "<string>"
    },
    "dadosEnvioPorConta": {
        "contaDestino": {
            "agencia": "<string>",
            "agenciaDigito": "<string>",
            "conta": "<string>",
            "contaDigito": "<string>",
            "contaPgto": "<string>"
        },
        "ispbDestino": "<string>",
        "nomeDestino": "<string>",
        "documentoFederalDestino": "<string>"
    },
    "valor": 123,
    "codigoOperacaoCliente": "<string>",
    "descricaoCliente": "<string>",
    "contaOrigem": {
        "agencia": "<string>",
        "agenciaDigito": "<string>",
        "conta": "<string>",
        "contaDigito": "<string>",
        "contaPgto": "<string>"
    },
    "informacoesAdicionais": "<string>",
    "idConciliacaoRecebedor": "<string>",
    "codigoLeituraQRCode": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "IdempotencyKey": "<idempotencykey>",
    "IgnoraHandshake": "<ignorahandshake>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    IdempotencyKey: '<idempotencykey>',
    IgnoraHandshake: '<ignorahandshake>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    dadosEnvioPorChave: {ticket: '3c90c3cc-0d44-4b50-8888-8dd25736052a', chave: '<string>'},
    dadosEnvioPorConta: {
      contaDestino: {
        agencia: '<string>',
        agenciaDigito: '<string>',
        conta: '<string>',
        contaDigito: '<string>',
        contaPgto: '<string>'
      },
      ispbDestino: '<string>',
      nomeDestino: '<string>',
      documentoFederalDestino: '<string>'
    },
    valor: 123,
    codigoOperacaoCliente: '<string>',
    descricaoCliente: '<string>',
    contaOrigem: {
      agencia: '<string>',
      agenciaDigito: '<string>',
      conta: '<string>',
      contaDigito: '<string>',
      contaPgto: '<string>'
    },
    informacoesAdicionais: '<string>',
    idConciliacaoRecebedor: '<string>',
    codigoLeituraQRCode: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Transferir', 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.com.br/api/Recurso/Transferir",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dadosEnvioPorChave' => [
        'ticket' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'chave' => '<string>'
    ],
    'dadosEnvioPorConta' => [
        'contaDestino' => [
                'agencia' => '<string>',
                'agenciaDigito' => '<string>',
                'conta' => '<string>',
                'contaDigito' => '<string>',
                'contaPgto' => '<string>'
        ],
        'ispbDestino' => '<string>',
        'nomeDestino' => '<string>',
        'documentoFederalDestino' => '<string>'
    ],
    'valor' => 123,
    'codigoOperacaoCliente' => '<string>',
    'descricaoCliente' => '<string>',
    'contaOrigem' => [
        'agencia' => '<string>',
        'agenciaDigito' => '<string>',
        'conta' => '<string>',
        'contaDigito' => '<string>',
        'contaPgto' => '<string>'
    ],
    'informacoesAdicionais' => '<string>',
    'idConciliacaoRecebedor' => '<string>',
    'codigoLeituraQRCode' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "IdempotencyKey: <idempotencykey>",
    "IgnoraHandshake: <ignorahandshake>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Transferir"

	payload := strings.NewReader("{\n  \"dadosEnvioPorChave\": {\n    \"ticket\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"chave\": \"<string>\"\n  },\n  \"dadosEnvioPorConta\": {\n    \"contaDestino\": {\n      \"agencia\": \"<string>\",\n      \"agenciaDigito\": \"<string>\",\n      \"conta\": \"<string>\",\n      \"contaDigito\": \"<string>\",\n      \"contaPgto\": \"<string>\"\n    },\n    \"ispbDestino\": \"<string>\",\n    \"nomeDestino\": \"<string>\",\n    \"documentoFederalDestino\": \"<string>\"\n  },\n  \"valor\": 123,\n  \"codigoOperacaoCliente\": \"<string>\",\n  \"descricaoCliente\": \"<string>\",\n  \"contaOrigem\": {\n    \"agencia\": \"<string>\",\n    \"agenciaDigito\": \"<string>\",\n    \"conta\": \"<string>\",\n    \"contaDigito\": \"<string>\",\n    \"contaPgto\": \"<string>\"\n  },\n  \"informacoesAdicionais\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"codigoLeituraQRCode\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("IdempotencyKey", "<idempotencykey>")
	req.Header.Add("IgnoraHandshake", "<ignorahandshake>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Transferir")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("IgnoraHandshake", "<ignorahandshake>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dadosEnvioPorChave\": {\n    \"ticket\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"chave\": \"<string>\"\n  },\n  \"dadosEnvioPorConta\": {\n    \"contaDestino\": {\n      \"agencia\": \"<string>\",\n      \"agenciaDigito\": \"<string>\",\n      \"conta\": \"<string>\",\n      \"contaDigito\": \"<string>\",\n      \"contaPgto\": \"<string>\"\n    },\n    \"ispbDestino\": \"<string>\",\n    \"nomeDestino\": \"<string>\",\n    \"documentoFederalDestino\": \"<string>\"\n  },\n  \"valor\": 123,\n  \"codigoOperacaoCliente\": \"<string>\",\n  \"descricaoCliente\": \"<string>\",\n  \"contaOrigem\": {\n    \"agencia\": \"<string>\",\n    \"agenciaDigito\": \"<string>\",\n    \"conta\": \"<string>\",\n    \"contaDigito\": \"<string>\",\n    \"contaPgto\": \"<string>\"\n  },\n  \"informacoesAdicionais\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"codigoLeituraQRCode\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Transferir")

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

request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["IgnoraHandshake"] = '<ignorahandshake>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dadosEnvioPorChave\": {\n    \"ticket\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"chave\": \"<string>\"\n  },\n  \"dadosEnvioPorConta\": {\n    \"contaDestino\": {\n      \"agencia\": \"<string>\",\n      \"agenciaDigito\": \"<string>\",\n      \"conta\": \"<string>\",\n      \"contaDigito\": \"<string>\",\n      \"contaPgto\": \"<string>\"\n    },\n    \"ispbDestino\": \"<string>\",\n    \"nomeDestino\": \"<string>\",\n    \"documentoFederalDestino\": \"<string>\"\n  },\n  \"valor\": 123,\n  \"codigoOperacaoCliente\": \"<string>\",\n  \"descricaoCliente\": \"<string>\",\n  \"contaOrigem\": {\n    \"agencia\": \"<string>\",\n    \"agenciaDigito\": \"<string>\",\n    \"conta\": \"<string>\",\n    \"contaDigito\": \"<string>\",\n    \"contaPgto\": \"<string>\"\n  },\n  \"informacoesAdicionais\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"codigoLeituraQRCode\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoTransacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

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

Realiza uma transferência via Pix.

curl --request POST \
  --url https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Transferir \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "dadosEnvioPorChave": {
    "ticket": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "chave": "<string>"
  },
  "dadosEnvioPorConta": {
    "contaDestino": {
      "agencia": "<string>",
      "agenciaDigito": "<string>",
      "conta": "<string>",
      "contaDigito": "<string>",
      "contaPgto": "<string>"
    },
    "ispbDestino": "<string>",
    "nomeDestino": "<string>",
    "documentoFederalDestino": "<string>"
  },
  "valor": 123,
  "codigoOperacaoCliente": "<string>",
  "descricaoCliente": "<string>",
  "contaOrigem": {
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPgto": "<string>"
  },
  "informacoesAdicionais": "<string>",
  "idConciliacaoRecebedor": "<string>",
  "codigoLeituraQRCode": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Transferir"

payload = {
    "dadosEnvioPorChave": {
        "ticket": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "chave": "<string>"
    },
    "dadosEnvioPorConta": {
        "contaDestino": {
            "agencia": "<string>",
            "agenciaDigito": "<string>",
            "conta": "<string>",
            "contaDigito": "<string>",
            "contaPgto": "<string>"
        },
        "ispbDestino": "<string>",
        "nomeDestino": "<string>",
        "documentoFederalDestino": "<string>"
    },
    "valor": 123,
    "codigoOperacaoCliente": "<string>",
    "descricaoCliente": "<string>",
    "contaOrigem": {
        "agencia": "<string>",
        "agenciaDigito": "<string>",
        "conta": "<string>",
        "contaDigito": "<string>",
        "contaPgto": "<string>"
    },
    "informacoesAdicionais": "<string>",
    "idConciliacaoRecebedor": "<string>",
    "codigoLeituraQRCode": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "IdempotencyKey": "<idempotencykey>",
    "IgnoraHandshake": "<ignorahandshake>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    IdempotencyKey: '<idempotencykey>',
    IgnoraHandshake: '<ignorahandshake>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    dadosEnvioPorChave: {ticket: '3c90c3cc-0d44-4b50-8888-8dd25736052a', chave: '<string>'},
    dadosEnvioPorConta: {
      contaDestino: {
        agencia: '<string>',
        agenciaDigito: '<string>',
        conta: '<string>',
        contaDigito: '<string>',
        contaPgto: '<string>'
      },
      ispbDestino: '<string>',
      nomeDestino: '<string>',
      documentoFederalDestino: '<string>'
    },
    valor: 123,
    codigoOperacaoCliente: '<string>',
    descricaoCliente: '<string>',
    contaOrigem: {
      agencia: '<string>',
      agenciaDigito: '<string>',
      conta: '<string>',
      contaDigito: '<string>',
      contaPgto: '<string>'
    },
    informacoesAdicionais: '<string>',
    idConciliacaoRecebedor: '<string>',
    codigoLeituraQRCode: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Transferir', 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.com.br/api/Recurso/Transferir",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dadosEnvioPorChave' => [
        'ticket' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'chave' => '<string>'
    ],
    'dadosEnvioPorConta' => [
        'contaDestino' => [
                'agencia' => '<string>',
                'agenciaDigito' => '<string>',
                'conta' => '<string>',
                'contaDigito' => '<string>',
                'contaPgto' => '<string>'
        ],
        'ispbDestino' => '<string>',
        'nomeDestino' => '<string>',
        'documentoFederalDestino' => '<string>'
    ],
    'valor' => 123,
    'codigoOperacaoCliente' => '<string>',
    'descricaoCliente' => '<string>',
    'contaOrigem' => [
        'agencia' => '<string>',
        'agenciaDigito' => '<string>',
        'conta' => '<string>',
        'contaDigito' => '<string>',
        'contaPgto' => '<string>'
    ],
    'informacoesAdicionais' => '<string>',
    'idConciliacaoRecebedor' => '<string>',
    'codigoLeituraQRCode' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "IdempotencyKey: <idempotencykey>",
    "IgnoraHandshake: <ignorahandshake>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Transferir"

	payload := strings.NewReader("{\n  \"dadosEnvioPorChave\": {\n    \"ticket\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"chave\": \"<string>\"\n  },\n  \"dadosEnvioPorConta\": {\n    \"contaDestino\": {\n      \"agencia\": \"<string>\",\n      \"agenciaDigito\": \"<string>\",\n      \"conta\": \"<string>\",\n      \"contaDigito\": \"<string>\",\n      \"contaPgto\": \"<string>\"\n    },\n    \"ispbDestino\": \"<string>\",\n    \"nomeDestino\": \"<string>\",\n    \"documentoFederalDestino\": \"<string>\"\n  },\n  \"valor\": 123,\n  \"codigoOperacaoCliente\": \"<string>\",\n  \"descricaoCliente\": \"<string>\",\n  \"contaOrigem\": {\n    \"agencia\": \"<string>\",\n    \"agenciaDigito\": \"<string>\",\n    \"conta\": \"<string>\",\n    \"contaDigito\": \"<string>\",\n    \"contaPgto\": \"<string>\"\n  },\n  \"informacoesAdicionais\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"codigoLeituraQRCode\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("IdempotencyKey", "<idempotencykey>")
	req.Header.Add("IgnoraHandshake", "<ignorahandshake>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Transferir")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("IgnoraHandshake", "<ignorahandshake>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dadosEnvioPorChave\": {\n    \"ticket\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"chave\": \"<string>\"\n  },\n  \"dadosEnvioPorConta\": {\n    \"contaDestino\": {\n      \"agencia\": \"<string>\",\n      \"agenciaDigito\": \"<string>\",\n      \"conta\": \"<string>\",\n      \"contaDigito\": \"<string>\",\n      \"contaPgto\": \"<string>\"\n    },\n    \"ispbDestino\": \"<string>\",\n    \"nomeDestino\": \"<string>\",\n    \"documentoFederalDestino\": \"<string>\"\n  },\n  \"valor\": 123,\n  \"codigoOperacaoCliente\": \"<string>\",\n  \"descricaoCliente\": \"<string>\",\n  \"contaOrigem\": {\n    \"agencia\": \"<string>\",\n    \"agenciaDigito\": \"<string>\",\n    \"conta\": \"<string>\",\n    \"contaDigito\": \"<string>\",\n    \"contaPgto\": \"<string>\"\n  },\n  \"informacoesAdicionais\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"codigoLeituraQRCode\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Transferir")

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

request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["IgnoraHandshake"] = '<ignorahandshake>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dadosEnvioPorChave\": {\n    \"ticket\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"chave\": \"<string>\"\n  },\n  \"dadosEnvioPorConta\": {\n    \"contaDestino\": {\n      \"agencia\": \"<string>\",\n      \"agenciaDigito\": \"<string>\",\n      \"conta\": \"<string>\",\n      \"contaDigito\": \"<string>\",\n      \"contaPgto\": \"<string>\"\n    },\n    \"ispbDestino\": \"<string>\",\n    \"nomeDestino\": \"<string>\",\n    \"documentoFederalDestino\": \"<string>\"\n  },\n  \"valor\": 123,\n  \"codigoOperacaoCliente\": \"<string>\",\n  \"descricaoCliente\": \"<string>\",\n  \"contaOrigem\": {\n    \"agencia\": \"<string>\",\n    \"agenciaDigito\": \"<string>\",\n    \"conta\": \"<string>\",\n    \"contaDigito\": \"<string>\",\n    \"contaPgto\": \"<string>\"\n  },\n  \"informacoesAdicionais\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"codigoLeituraQRCode\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoTransacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

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

Through this endpoint, the partner can make transfers using a Pix key, bank details, or QR Code.

In production, the use of HandShake and HMAC is mandatory.

Transfer via PIX Key: In this model, for the client to successfully complete the request, the client must query the key at the /api/Chave/Consultar endpoint to obtain the “ticket.” In this case, the key that will receive the transfer is required.Transfer via Bank Details: In this model, for the client to successfully complete the request, the client must provide the destination account details, including the branch, account, account type, account model, destination ISPB (Brazilian Social Security Number), name, and beneficiary’s federal ID.Transfer via QR Code: In this model, for the client to successfully complete the request, the client must query the key at the /api/QRCode/Ler endpoint to obtain the “QRCodeReadingCode” (CodigoLeituraQRCode).

Authorizations

Authorization

string

header

required

Copie 'Bearer ' + token

Headers

IdempotencyKey

string

required

IgnoraHandshake

boolean

default:true

required

(somente em homologação)

Body

dadosEnvioPorChave

object | null

Objeto detalhando os dados da chave Pix para transação.

Observação:

Obrigatório para transações através de chave.

Show child attributes

dadosEnvioPorConta

object | null

Objeto detalhando os dados da Conta para transação.

Observação:

Obrigatório para transações através de dados da conta.

Show child attributes

valor

number<double>

Valor da Transação.*

codigoOperacaoCliente

string | null

Identificador fornecido pelo remetente para facilitar a conciliação e o rastreamento da transação.

descricaoCliente

string | null

Descrição opcional fornecida pelo Remetente.

prioridade

enum<integer> | null

Prioridade do PIX.

Valores: 0 - URGENTE 1 - NORMAL

Available options:

0,

1

contaOrigem

object | null

Objeto detalhado da conta bancária do remetente.*

Show child attributes

informacoesAdicionais

string | null

Detalhes adicionais relacionados à transação Pix.*

idConciliacaoRecebedor

string | null

Identificador de conciliação do recebedor da transação (TXID).

tpQRCode

enum<integer> | null

Tipo de QRCODE.

Valores: 1 - Estático 2 - Dinâmico 3 - Composto

Available options:

1,

2,

3

codigoLeituraQRCode

string<uuid>

Indentificador UUID de leitura do QR Code.

Response

Success

sucesso

boolean

mensagem

string | null

codigoTransacao

string<uuid>

15 - Consult QR Code on Hybrid Bill 17 - Return Resource