Consultar pagamento

curl --request GET \
  --url https://api.uvvipay.com.br/v1/payments/{id} \
  --header 'client-id: <api-key>' \
  --header 'client-secret: <api-key>'

import requests

url = "https://api.uvvipay.com.br/v1/payments/{id}"

headers = {
    "client-secret": "<api-key>",
    "client-id": "<api-key>"
}

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

print(response.text)

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

fetch('https://api.uvvipay.com.br/v1/payments/{id}', 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.uvvipay.com.br/v1/payments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "client-id: <api-key>",
    "client-secret: <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.uvvipay.com.br/v1/payments/{id}"

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

	req.Header.Add("client-secret", "<api-key>")
	req.Header.Add("client-id", "<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.uvvipay.com.br/v1/payments/{id}")

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

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

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

{
  "id": "d398b016-3c29-41b4-afc0-bbf8c81c683c",
  "status": "paid",
  "amount": 15680,
  "paymentMethod": "credit_card",
  "createdAt": "2026-07-02T19:41:46.738Z",
  "transactionId": "<string>",
  "pix": {
    "qrcode": "<string>"
  },
  "boleto": {
    "url": "https://exemplo.com/boleto/abc123",
    "digitableLine": "34191.79001 01043.510047 91020.150008 1 98760000012345"
  },
  "refusedReason": {
    "category": "issuer_declined",
    "code": "51",
    "description": "Recusa do banco emissor"
  },
  "subMerchant": {
    "internalId": "550e8400-e29b-41d4-a716-446655440000",
    "legalName": "Loja do João LTDA",
    "documentType": "cnpj",
    "documentNumber": "12345678000199"
  },
  "split": [
    {
      "recipient_id": "5b9f3d6a-3a2c-4d6f-9b9e-0a1b2c3d4e5f",
      "amount": 2500
    }
  ],
  "customer": {
    "name": "Gustavo Marin",
    "email": "gustavomarin616@hotmail.com",
    "phone": "55996299418",
    "documentNumber": "77042506049",
    "documentType": "cpf",
    "address": {
      "zipCode": "98300000",
      "street": "Major Novais",
      "streetNumber": "444",
      "neighborhood": "Centro",
      "city": "Palmeira das Missões",
      "state": "RS",
      "country": "BR"
    }
  },
  "items": [
    {
      "title": "Produto X",
      "quantity": 1,
      "tangible": true,
      "unitPrice": 15680
    }
  ],
  "externalReference": "35d29135-f14e-4695-b9ae-ccde91676a60"
}

GET

payments

{id}

Consultar pagamento

curl --request GET \
  --url https://api.uvvipay.com.br/v1/payments/{id} \
  --header 'client-id: <api-key>' \
  --header 'client-secret: <api-key>'

import requests

url = "https://api.uvvipay.com.br/v1/payments/{id}"

headers = {
    "client-secret": "<api-key>",
    "client-id": "<api-key>"
}

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

print(response.text)

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

fetch('https://api.uvvipay.com.br/v1/payments/{id}', 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.uvvipay.com.br/v1/payments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "client-id: <api-key>",
    "client-secret: <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.uvvipay.com.br/v1/payments/{id}"

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

	req.Header.Add("client-secret", "<api-key>")
	req.Header.Add("client-id", "<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.uvvipay.com.br/v1/payments/{id}")

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

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

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

{
  "id": "d398b016-3c29-41b4-afc0-bbf8c81c683c",
  "status": "paid",
  "amount": 15680,
  "paymentMethod": "credit_card",
  "createdAt": "2026-07-02T19:41:46.738Z",
  "transactionId": "<string>",
  "pix": {
    "qrcode": "<string>"
  },
  "boleto": {
    "url": "https://exemplo.com/boleto/abc123",
    "digitableLine": "34191.79001 01043.510047 91020.150008 1 98760000012345"
  },
  "refusedReason": {
    "category": "issuer_declined",
    "code": "51",
    "description": "Recusa do banco emissor"
  },
  "subMerchant": {
    "internalId": "550e8400-e29b-41d4-a716-446655440000",
    "legalName": "Loja do João LTDA",
    "documentType": "cnpj",
    "documentNumber": "12345678000199"
  },
  "split": [
    {
      "recipient_id": "5b9f3d6a-3a2c-4d6f-9b9e-0a1b2c3d4e5f",
      "amount": 2500
    }
  ],
  "customer": {
    "name": "Gustavo Marin",
    "email": "gustavomarin616@hotmail.com",
    "phone": "55996299418",
    "documentNumber": "77042506049",
    "documentType": "cpf",
    "address": {
      "zipCode": "98300000",
      "street": "Major Novais",
      "streetNumber": "444",
      "neighborhood": "Centro",
      "city": "Palmeira das Missões",
      "state": "RS",
      "country": "BR"
    }
  },
  "items": [
    {
      "title": "Produto X",
      "quantity": 1,
      "tangible": true,
      "unitPrice": 15680
    }
  ],
  "externalReference": "35d29135-f14e-4695-b9ae-ccde91676a60"
}

Authorizations

client-id

string

header

required

client-secret

string

header

required

Headers

client-secret

string

required

Secret da credencial do merchant

client-id

string

required

ID público da credencial do merchant

Path Parameters

string

required

ID único da transação

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Dados do pagamento

string<uuid>

required

Example:

"d398b016-3c29-41b4-afc0-bbf8c81c683c"

status

enum<string>

required

Available options:

waiting_payment,

paid,

refused,

refunded,

in_analysis

Example:

"paid"

amount

number

required

Example:

15680

paymentMethod

string

required

Example:

"credit_card"

createdAt

string<date-time>

required

Example:

"2026-07-02T19:41:46.738Z"

transactionId

string

pix

object

Show child attributes

boleto

object

Show child attributes

refusedReason

object

Motivo da recusa (presente apenas quando status = refused). Consulte o guia Recusas de cartão para entender as categorias e como orientar o cliente.

Show child attributes

subMerchant

object

Dados públicos do submerchant (owner) vinculado à transação.

Show child attributes

split

object[]

Split resolvido da transação: valor efetivamente destinado a cada recebedor, em centavos (quando a transação possui split)

Show child attributes

customer

object

Dados completos do cliente (presente quando disponível).

Show child attributes

items

object[]

Show child attributes

externalReference

string

Example:

"35d29135-f14e-4695-b9ae-ccde91676a60"