Skip to main content
PUT
/
v0
/
merchantIntegrations
Upsert
curl --request PUT \
  --url https://api.paygentic.io/v0/merchantIntegrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantId": "<string>",
  "provider": "salesforce",
  "externalId": "<string>",
  "config": {},
  "metadata": {}
}
'
{
  "id": "<string>",
  "object": "merchantIntegration",
  "merchantId": "<string>",
  "provider": "salesforce",
  "externalId": "<string>",
  "config": {},
  "metadata": {},
  "connectedAt": "2023-11-07T05:31:56Z",
  "disconnectedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json
​
merchantId
string
required

Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$
​
provider
enum<string>
required

External provider a merchant can connect at the tenant level

Available options:
salesforce
​
externalId
string

Ampersand installation id.

Maximum string length: 255
​
status
enum<string>

Connection lifecycle state. Live Ampersand health is separate and not stored here.

Available options:
active,
disconnected,
error
​
config
object
​
metadata
object

Response

Merchant integration upserted

A merchant's tenant-level connection to an external provider via Ampersand.

​
id
string
required

Unique identifier for a merchant integration

Pattern: ^mint_[a-zA-Z0-9]+$
​
object
enum<string>
default:merchantIntegration
required
Available options:
merchantIntegration
​
merchantId
string
required

Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$
​
provider
enum<string>
required

External provider a merchant can connect at the tenant level

Available options:
salesforce
​
externalId
string | null
required

Ampersand installation id.

​
status
enum<string>
required

Connection lifecycle state. Live Ampersand health is separate and not stored here.

Available options:
active,
disconnected,
error
​
config
object
required
​
metadata
object
required
​
connectedAt
string<date-time>
required
​
disconnectedAt
string<date-time> | null
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required