List

GET /v0/externalReferences

List

cURL

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

import requests

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

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', 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",
  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"

	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")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "data": [
    {
      "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>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

{
  "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

Query Parameters

merchantId · string

Restrict results to a specific merchant. All active filters AND together.

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

entityType · enum<string>

Filter by the Paygentic entity type the reference points at (e.g. item). All active filters AND together. The type of Paygentic entity this external reference points at

Available options: item, customer

entityId · string

Filter by the Paygentic entity id (e.g. itm_xxx). This is the inverse of the GET /v0/items?provider=&externalId= resolution endpoint — look up references from the Paygentic side. All active filters AND together.

provider · string

Filter by provider (e.g. salesforce, netsuite). All active filters AND together. Lowercase snake_case provider identifier (e.g. salesforce, netsuite)

Maximum string length: 64

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

externalId · string

Filter by the external system's record id. Pair with provider to look up all Paygentic entities that carry a given external reference. All active filters AND together. Identifier of the record in the external system

Maximum string length: 255

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

limit · integer · default: 50

Required range: 1 <= x <= 100

offset · integer · default: 0

Required range: x >= 0

Response

200

application/json

List of external references

data · object[] · required

Show child attributes

pagination · object · required

Offset-based pagination response.

Show child attributes