Mandatory routing header to direct the request to the appropriate regional products
Type
string
Required
Valid values
"EU""US""UK"
Path Parameters
payoutLinkId*
The ID of the link to retrieve. Note: Forward slashes ('/') act as URI path separators, causing a 404 Not Found routing error rather than a 400 Bad Request regex mismatch.
The URL of the payout link. Returned only for active payout links.
Format"uri"
payoutLinkId
string
Required
Unique, client-generated identifier for the payout request. Used to track and reconcile the payout across your internal systems.
Min Length7
Max Length90
Pattern"^[-_a-zA-Z0-9]+$"
counterpartyReference
string
Required
The unique cross-system identifier for the counterparty (e.g., ERP vendor ID). Facilitates seamless mapping between the Synthix ledger and your internal CRM/ERP.
Max Length36
Min Length3
Pattern"^[-_a-zA-Z0-9]+$"
accountHolderName
string
The full legal name of the individual or entity as registered with their financial institution. Critical for matching during Anti-Money Laundering (AML) checks.
Min Length3
Max Length90
Pattern"^[-_ a-zA-Z0-9]+$"
debtorAccountIdentifier
object
Required
The debtor account identifier on the payout link. Can be either an IBAN (type: IBAN) or an account ID (type: ID).
Collapse
type
string
Required
Type of account identifier.
IBAN — International Bank Account Number (EUR/GBP accounts).
ID — Local account number.
Valid values"ID""IBAN"
value
string
Required
Value of the account identifier.
For IBAN: uppercase alphanumeric, e.g. DE89370400440532013000.
For ID: digits only — 9-18 digits for INR, any digits for USD.
Min Length1
Max Length34
Pattern"^[A-Z0-9]+$"
amount
string
Required
Decimal string. 1–999999999.99, max 2 dp.
Pattern"^\\d{1,9}(\\.\\d{1,2})?$"
currency
string
Required
The 3-letter ISO 4217 currency code. Supported values: EUR, USD, GBP. This determines the settlement currency and applicable regional payment rails.
Valid values"EUR""USD""GBP"
remarksForReconciliation
string
Required
A clear, descriptive narrative that appears on the recipient's bank statement. Essential for automated reconciliation and 'know your payment' (KYP) transparency.
The expiry date and time for the payout link, expressed in ISO 8601 format. If the recipient does not claim the funds before the expiry, the link becomes invalid. The default and maximum expiry is 7 days from the time of link creation. Example: 2024-03-24T03:14:15Z.
ISO 8601-shaped period after which the payout link expires
(e.g. p7d). Echoed verbatim from the create-request so clients
can reconcile by the chosen window rather than the absolute expiryDate.
This fields captures the maximum attempts allowed for account verification. This is an optional input applicable only if "accountVerificationOption" is "MANDATORY_VERIFICATION" or "OPTIONAL_VERIFICATION". Possible values are 3 or 5.
Valid values35
brandThemeId
string
Optional reference to a branding template. When supplied, must exist, belong to the calling tenant, and be of payout type. If the referenced template is ACTIVE, the hosted payout-link page renders with the tenant's branding; otherwise Synthix defaults apply.
Format"uuid"
uiMode
string
The mode in which the payout link is rendered. hosted: Synthix-hosted full-page checkout. embedded: partner-controlled iframe via the Synthix SDK.
Valid values"hosted""embedded"
Default"hosted"
Response Headers
Deprecation
Indicates deprecation (boolean)
Typestring
Exampletrue
Sunset
Sunset date in HTTP-date format [ISO 8601]. Example: `2024-03-24T03:14:15Z`.