Get

GET /v0/externalReferences/{id}

Get

cURL

curl --request GET \
  --url https://api.paygentic.io/v0/externalReferences/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.paygentic.io/v0/externalReferences/{id}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paygentic.io/v0/externalReferences/{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.paygentic.io/v0/externalReferences/{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: Bearer <token>"
  ],
]);

$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.paygentic.io/v0/externalReferences/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.paygentic.io/v0/externalReferences/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/externalReferences/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "id": "<string>",
  "object": "externalReference",
  "merchantId": "<string>",
  "entityId": "<string>",
  "provider": "<string>",
  "externalId": "<string>",
  "metadata": {},
  "isPrimary": true,
  "isDefault": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "externalLabel": "<string>"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

Authorizations

Authorization · string · header · required

API key authentication

Path Parameters

id · string · required

The unique identifier of the external reference

Pattern: ^xrf_[a-zA-Z0-9]+$

Response

200

application/json

External reference

Links a Paygentic entity to a record in an external system such as Salesforce or NetSuite.

id · string · required

Unique identifier for an external reference

Pattern: ^xrf_[a-zA-Z0-9]+$

object · enum<string> · default: externalReference · required

Available options: externalReference

merchantId · string · required

Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$

entityType · enum<string> · required

The type of Paygentic entity this external reference points at

Available options: item, customer

entityId · string · required

provider · string · required

Lowercase snake_case provider identifier (e.g. salesforce, netsuite)

Maximum string length: 64

Pattern: ^[a-z][a-z0-9_]*$

externalId · string · required

Optional external identifier for cross-referencing with external systems. Alphanumeric characters, hyphens, and underscores only.

Maximum string length: 255

Pattern: ^[a-zA-Z0-9_-]+$

metadata · object · required

isPrimary · boolean · required

isDefault · boolean · required

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

externalLabel · string | null