Obter transação externa

curl --request GET \
  --url https://api.juridiq.com.br/financial/transactions/external/{externalId} \
  --header 'x-juridiq-api-key: <api-key>'

import requests

url = "https://api.juridiq.com.br/financial/transactions/external/{externalId}"

headers = {"x-juridiq-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/financial/transactions/external/{externalId}', 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.juridiq.com.br/financial/transactions/external/{externalId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <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.juridiq.com.br/financial/transactions/external/{externalId}"

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

	req.Header.Add("x-juridiq-api-key", "<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.juridiq.com.br/financial/transactions/external/{externalId}")

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

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

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

{
  "kind": "PAYMENT",
  "value": 123,
  "createdAt": "<string>",
  "status": "<string>",
  "dueDate": "<string>",
  "paymentDate": "<string>",
  "installmentNumber": 123,
  "discount": {
    "value": 123,
    "dueDateLimitDays": 1,
    "type": "FIXED"
  },
  "fine": {
    "value": 123,
    "type": "FIXED"
  },
  "interest": {
    "value": 123
  },
  "invoiceUrl": "<string>",
  "gatewayPaymentUrl": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

GET

financial

transactions

external

{externalId}

Obter transação externa

curl --request GET \
  --url https://api.juridiq.com.br/financial/transactions/external/{externalId} \
  --header 'x-juridiq-api-key: <api-key>'

import requests

url = "https://api.juridiq.com.br/financial/transactions/external/{externalId}"

headers = {"x-juridiq-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/financial/transactions/external/{externalId}', 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.juridiq.com.br/financial/transactions/external/{externalId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <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.juridiq.com.br/financial/transactions/external/{externalId}"

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

	req.Header.Add("x-juridiq-api-key", "<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.juridiq.com.br/financial/transactions/external/{externalId}")

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

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

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

{
  "kind": "PAYMENT",
  "value": 123,
  "createdAt": "<string>",
  "status": "<string>",
  "dueDate": "<string>",
  "paymentDate": "<string>",
  "installmentNumber": 123,
  "discount": {
    "value": 123,
    "dueDateLimitDays": 1,
    "type": "FIXED"
  },
  "fine": {
    "value": 123,
    "type": "FIXED"
  },
  "interest": {
    "value": 123
  },
  "invoiceUrl": "<string>",
  "gatewayPaymentUrl": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Authorizations

x-juridiq-api-key

string

header

required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key.

Path Parameters

externalId

string

required

Response

Default Response

kind

enum<string>

required

Available options:

PAYMENT,

INSTALLMENT,

SUBSCRIPTION

value

number

required

createdAt

string

required

status

string

required

dueDate

string

required

paymentDate

string | null

required

installmentNumber

number | null

required

discount

object

required

Show child attributes

fine

object

required

Show child attributes

interest

object

required

Show child attributes

invoiceUrl

string

required

gatewayPaymentUrl

string

required

Primeiros Passos

API Reference

Obter transação externa

Authorizations

Path Parameters

Response