API Reference

Update Connection Details

patch
https://api.preczn.com/v1/merchants//connections/
Path Params
string
required

The Preczn merchant which connections will be updated.

string
enum
required

The connection enumerations on the merchant record that should be updated.

Body Params
connectionspecificRequirements
object
string
enum

This field is designed to update the connection status of a merchant for the purpose of testing status changes. Consequently, this field is only applicable to test merchants.

string

The date and time when the merchant officially completed onboarding with the connection. This value is retrieved from connections that provide an official onboarding timestamp.

string

The text that is set when an action is required on the merchant connect. Will be displayed to merchants in RFI forms.

boolean

Flag to designate if an Operator has reviewed and approved the description before it's presented to merchants.

boolean

Flag to indicate if there is action needed. May be set independently in the event no description is provided.

string

A property to share the merchant's key for the connection, commonly an API key. When sent, this will be verified with the connection, and if valid, it will be saved. It is used for subscribing to webhooks and performing API requests. Please review the connection guides to understand which properties are required for each connection.This field cannot contain spaces.

string

A property to share the merchant's secret for the connection. When sent, this will be verified with the connection, and if valid, it will be saved. It is used for subscribing to webhooks and performing API requests. Please review the connection guides to understand which properties are required for each connection.This field cannot contain spaces.

string

A property to share the merchant's id for the connection. When sent, this will be verified with the connection, and if valid, it will be saved. It is used for subscribing to webhooks and performing API requests. Please review the connection guides to understand which properties are required for each connection.This field cannot contain spaces.

string

A property to share the merchant's ID used specifically for ACH transactions. When provided, this value will be verified with the connection, and if valid, it will be saved. It is used for performing ACH-related API requests. Please review the connection guides to understand which properties are required for each connection.This field cannot contain spaces.

string

A property to share the merchant's environment for the connection. When sent, this will be verified with the connection, and if valid, it will be saved. It is used for subscribing to webhooks and performing API requests. Please review the connection guides to understand which properties are required for each connection.

string

The CardPointe site URL prefix (e.g. "site-uat" resolves to https://site-uat.cardconnect.com). Only applicable to CardPointe connections. This field cannot contain spaces.

string

Requirement template ID.

string

Links this merchant AFP connection to a specific platform AFP connection (platform.processors[].id). Required when the platform has multiple AFP connections.

string

Adyen Balance Account ID for split payments and fund management (AFP only).

string

Adyen Legal Entity ID for KYC/boarding with Legal Entity Management API (AFP only).

Headers
string

Unique key to ensure idempotency of requests. If provided, the server will return the same response for subsequent requests with the same key.

Responses

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago