Update Connection Specific Requirements

patch

https://api.preczn.com/v1/forms/{formId}/ConnectionSpecificRequirements

Updates the connection-specific requirements for a boarding form. For multi-connection forms, pass the connectionId query parameter to specify which connection's requirements to update.

Path Params

formId

string

required

Query Params

step

string

required

connectionId

string

Connection ID to update requirements for. Defaults to the form's connectionId if omitted.

Body Params

tosDate

string

Date when the terms of service/conditions were signed.

tosIp

string

The IP address address of the machine that approved the terms of service/conditions.

userAgent

string

The user agent value from the request that approved the terms of service/conditions.

tosVersion

string

The version number of the terms of service/conditions that was signed.

tosAcceptedByOwnerId

string

The ID of the merchant owner who accepted the Terms of Service. Must exist in the form's owners list. Used for AFP connections to identify the TOS signer.

billingType

string

enum

Used to define how the merchant will be billed at the connection. Used by Rainforest

Allowed:

billingGroups

array of strings

The billing groups associated with the connection e.g Rainforest.

billingGroups

customField

string

length ≤ 50

This field is utilized to convey metadata to specific connections during the onboarding process.

channel

string

A static value that is used by certain connections to identify the partner.

presentedDisclosures

string

Disclosure text that was presented when terms of service/conditions was signed.

blackbox

string

A unique anti-fraud code that is generated when terms of service/conditions was signed.

signingContact

object

Information about the user that approved the boarding form last.

newUserLoginData

object

Data that is sent to the connection to establish the initial user login to the connection's merchant portal. Used solely to establish the first connection and do not update with user changes.

platformConnectionId

string

Links this merchant AFP connection to a specific platform AFP connection. Required for AdyenForPlatforms processors.

adyenTosDocuments

array of objects

Array of Adyen TOS documents to accept. Normalized from comma-separated tosVersion if not provided directly.

adyenTosDocuments

adyenStoreId

string

Adyen Store ID for the merchant connection. Distinct from Jaris shopId.

adyenPaymentMethodIds

array of strings

Array of Adyen Payment Method IDs configured for this merchant connection.

adyenPaymentMethodIds

pciTemplateReferences

array of strings

Array of PCI template reference IDs to sign. Returned by the GET pci-questionnaires endpoint.

pciTemplateReferences

pciSignedByOwnerId

string

The ID of the merchant owner who signed the PCI questionnaire. Must exist in the form's owners list.

pciQuestionnaireIds

string

Comma-separated Adyen PCI questionnaire IDs returned after signing.

pciSignedDate

string

ISO 8601 timestamp of when the PCI questionnaire was signed.

greenskyPrimaryBusinessCategory

string

enum

The GreenSky primary business category for this merchant connection.

contacts

object

Role-to-subject polymorphic refs. Each role (account, credit, sales, marketing, applicant) holds { subjectType: "owner" | "contact", subjectId: string }.

Response

200