Skip to main content
POST
/
v0
/
externalReferences
Create
curl --request POST \
  --url https://api.paygentic.io/v0/externalReferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantId": "<string>",
  "entityId": "<string>",
  "provider": "<string>",
  "externalId": "<string>",
  "externalLabel": "<string>",
  "metadata": {},
  "isPrimary": true,
  "isDefault": false
}
'
import requests

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

payload = {
"merchantId": "<string>",
"entityId": "<string>",
"provider": "<string>",
"externalId": "<string>",
"externalLabel": "<string>",
"metadata": {},
"isPrimary": True,
"isDefault": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
merchantId: '<string>',
entityId: '<string>',
provider: '<string>',
externalId: '<string>',
externalLabel: '<string>',
metadata: {},
isPrimary: true,
isDefault: false
})
};

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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'merchantId' => '<string>',
'entityId' => '<string>',
'provider' => '<string>',
'externalId' => '<string>',
'externalLabel' => '<string>',
'metadata' => [

],
'isPrimary' => true,
'isDefault' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

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

payload := strings.NewReader("{\n \"merchantId\": \"<string>\",\n \"entityId\": \"<string>\",\n \"provider\": \"<string>\",\n \"externalId\": \"<string>\",\n \"externalLabel\": \"<string>\",\n \"metadata\": {},\n \"isPrimary\": true,\n \"isDefault\": false\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.paygentic.io/v0/externalReferences")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"merchantId\": \"<string>\",\n \"entityId\": \"<string>\",\n \"provider\": \"<string>\",\n \"externalId\": \"<string>\",\n \"externalLabel\": \"<string>\",\n \"metadata\": {},\n \"isPrimary\": true,\n \"isDefault\": false\n}")
.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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"merchantId\": \"<string>\",\n \"entityId\": \"<string>\",\n \"provider\": \"<string>\",\n \"externalId\": \"<string>\",\n \"externalLabel\": \"<string>\",\n \"metadata\": {},\n \"isPrimary\": true,\n \"isDefault\": false\n}"

response = http.request(request)
puts response.read_body
{
  "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"
}
{
"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

Body

application/json
merchantId
string
required
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

Paygentic id of the entity, e.g. itm_xxx

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

Identifier of the record in the external system

Maximum string length: 255
Pattern: ^[a-zA-Z0-9_-]+$
externalLabel
string

Human-friendly name shown in UIs (e.g. a NetSuite financial-treatment name)

Maximum string length: 255
metadata
object

Provider-specific fields (e.g. { "sfObject": "Product2" })

isPrimary
boolean
default:true

Whether this is the canonical reference for (provider, externalId). The primary is unique per merchant; non-primary references are aliases.

isDefault
boolean
default:false

Whether this is the default target for the entity + provider. At most one default per (entityType, entityId, provider).

Response

External reference created

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