Realizar Pagamento

POST /v2/pix/payment

Realizar Pagamento

cURL

curl --request POST \
  --url https://api.example.com/v2/pix/payment \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "external_id": "<string>",
  "payerQuestion": "<string>",
  "postbackUrl": "<string>",
  "creditParty": {
    "key": "<string>",
    "keyType": "<string>",
    "document": "<string>",
    "name": "<string>"
  }
}
'

import requests

url = "https://api.example.com/v2/pix/payment"

payload = {
    "amount": 123,
    "external_id": "<string>",
    "payerQuestion": "<string>",
    "postbackUrl": "<string>",
    "creditParty": {
        "key": "<string>",
        "keyType": "<string>",
        "document": "<string>",
        "name": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 123,
    external_id: '<string>',
    payerQuestion: '<string>',
    postbackUrl: '<string>',
    creditParty: {key: '<string>', keyType: '<string>', document: '<string>', name: '<string>'}
  })
};

fetch('https://api.example.com/v2/pix/payment', 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.example.com/v2/pix/payment",
  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([
    'amount' => 123,
    'external_id' => '<string>',
    'payerQuestion' => '<string>',
    'postbackUrl' => '<string>',
    'creditParty' => [
        'key' => '<string>',
        'keyType' => '<string>',
        'document' => '<string>',
        'name' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/v2/pix/payment"

	payload := strings.NewReader("{\n  \"amount\": 123,\n  \"external_id\": \"<string>\",\n  \"payerQuestion\": \"<string>\",\n  \"postbackUrl\": \"<string>\",\n  \"creditParty\": {\n    \"key\": \"<string>\",\n    \"keyType\": \"<string>\",\n    \"document\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}")

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

	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.example.com/v2/pix/payment")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 123,\n  \"external_id\": \"<string>\",\n  \"payerQuestion\": \"<string>\",\n  \"postbackUrl\": \"<string>\",\n  \"creditParty\": {\n    \"key\": \"<string>\",\n    \"keyType\": \"<string>\",\n    \"document\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/pix/payment")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 123,\n  \"external_id\": \"<string>\",\n  \"payerQuestion\": \"<string>\",\n  \"postbackUrl\": \"<string>\",\n  \"creditParty\": {\n    \"key\": \"<string>\",\n    \"keyType\": \"<string>\",\n    \"document\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}"

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

Realiza um pagamento Pix para uma chave específica (Cash-out).

Headers

Header	Valor	Descrição
Authorization	Bearer <access_token>	Token de acesso.

Parâmetros do Body

amount · number · required

Valor do pagamento.

external_id · string · required

ID único para identificar o pagamento.

payerQuestion · string

Descrição do pagamento.

postbackUrl · string

URL para receber notificações de status.

creditParty · object · required

Dados do beneficiário.

Show properties

key · string · required

Chave Pix

keyType · string · required

Tipo de chave (EMAIL, CPF, CNPJ, PHONE, EVP)

document · string

CPF/CNPJ do beneficiário

name · string

Nome do beneficiário