Pular para o conteúdo principal
GET
/
v1
/
payments
/
{id}
Obter um pagamento por ID
curl --request GET \
  --url https://payments.sandbox.lerian.net/v1/payments/{id} \
  --header 'Authorization: <api-key>' \
  --header 'X-Organization-Id: <x-organization-id>'
import requests

url = "https://payments.sandbox.lerian.net/v1/payments/{id}"

headers = {
"X-Organization-Id": "<x-organization-id>",
"Authorization": "<api-key>"
}

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

print(response.text)
const options = {
method: 'GET',
headers: {'X-Organization-Id': '<x-organization-id>', Authorization: '<api-key>'}
};

fetch('https://payments.sandbox.lerian.net/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://payments.sandbox.lerian.net/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 => [
"Authorization: <api-key>",
"X-Organization-Id: <x-organization-id>"
],
]);

$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://payments.sandbox.lerian.net/v1/payments/{id}"

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

req.Header.Add("X-Organization-Id", "<x-organization-id>")
req.Header.Add("Authorization", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://payments.sandbox.lerian.net/v1/payments/{id}")
.header("X-Organization-Id", "<x-organization-id>")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://payments.sandbox.lerian.net/v1/payments/{id}")

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

request = Net::HTTP::Get.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "amount": "<string>",
  "canceledAt": "<string>",
  "createdAt": "<string>",
  "darf": {
    "fineAmount": "<string>",
    "interestAmount": "<string>",
    "mainAmount": "<string>",
    "name": "<string>",
    "personType": "<string>",
    "referenceDate": "<string>",
    "taxId": "<string>",
    "treasuryRevenueCode": "<string>",
    "type": "<string>"
  },
  "description": "<string>",
  "digitableLine": "<string>",
  "dueDate": "<string>",
  "errorMessage": "<string>",
  "failedAt": "<string>",
  "id": "<string>",
  "payee": {
    "name": "<string>",
    "taxId": "<string>"
  },
  "providerId": "<string>",
  "rejectedAt": "<string>",
  "scheduledDate": "<string>",
  "settledAmount": "<string>",
  "settledAt": "<string>",
  "status": "<string>",
  "type": "<string>"
}
{
"code": "PBP-0001",
"details": {},
"message": "dueDate must be in YYYY-MM-DD format",
"title": "Bad Request"
}
{
"code": "PBP-0001",
"details": {},
"message": "dueDate must be in YYYY-MM-DD format",
"title": "Bad Request"
}
{
"code": "PBP-0001",
"details": {},
"message": "dueDate must be in YYYY-MM-DD format",
"title": "Bad Request"
}
{
"code": "PBP-0001",
"details": {},
"message": "dueDate must be in YYYY-MM-DD format",
"title": "Bad Request"
}

Autorizações

Authorization
string
header
obrigatório

Bearer token authentication (format: "Bearer {token}")

Cabeçalhos

X-Organization-Id
string
obrigatório

Tenant organization ID

Parâmetros de caminho

id
string
obrigatório

Payment ID (UUID)

Resposta

OK

amount
string
canceledAt
string
createdAt
string
darf
object
description
string
digitableLine
string
dueDate
string
errorMessage
string
failedAt
string
id
string
payee
object
providerId
string
rejectedAt
string
scheduledDate
string
settledAmount
string
settledAt
string
status
string
type
string