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>",
  "entityType": "item",
  "entityId": "<string>",
  "provider": "<string>",
  "externalId": "<string>",
  "externalLabel": "<string>",
  "metadata": {},
  "isPrimary": true,
  "isDefault": false
}
'
{
  "id": "<string>",
  "object": "externalReference",
  "merchantId": "<string>",
  "entityType": "item",
  "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>"
}

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
​
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
​
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