Skip to navigation
Settlement Payouts

Link Account to Settlement

View as Markdown

Re-points a customer’s dedicated account or a corporate sub-account so its future inbound credits land in a different settlement account. Provide exactly one of customer_reference (when type is REGULAR) or corporate_reference (when type is CORPORATE).

Body (JSON)

FieldTypeRequiredNotes
typestringyesREGULAR or CORPORATE
settlementIdintegeryesTarget settlement account; must be a JSON number
customer_referencestringwhen type=REGULARCustomer ID (must already have a dedicated account)
corporate_referencestringwhen type=CORPORATECorporate sub-account ID

Behaviour notes

  • Checks run in this order: settlementId, then type, then the reference for that type.
  • Linking to the settlement the account already uses returns 200 with an “already linked” message.
  • No data is returned.

Authentication

AuthorizationBearer

Access token from Generate Access Token (valid 15 minutes).

Request

This endpoint expects an object.
typestringOptional
customer_referencestringOptional
settlementIdintegerOptional

Response

Updated / Already linked (customer) / Already linked (corporate)

statusstringOptional
messagestringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error