Skip to main content
POST
/
payment
/
config
/
{payrollConfigId}
Create payment configuration for an organisation
curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "method": "BACS",
  "format": "Barclays",
  "reference": "Salary{separator:space}{payDate}",
  "referenceDateFormat": "DMY_COMPACT",
  "bacs": {
    "sortCode": "12-34-56",
    "accountNumber": "12345678",
    "serviceUserNumber": "SUN123"
  }
}
'
{
  "message": {
    "text": "Payment configuration created successfully",
    "token": "createOrganisationPaymentConfigSuccess",
    "tokenArguments": []
  },
  "content": {
    "data": {
      "method": "BACS",
      "format": "Barclays",
      "fileFormat": "txt",
      "reference": "Payroll May 2024",
      "referenceDateFormat": "DMY_COMPACT",
      "payrollConfigId": "org-payroll-123",
      "bacs": {
        "sortCode": "12-34-56",
        "accountNumber": "12345678",
        "serviceUserNumber": "SUN123"
      },
      "createdDate": "2024-05-01T12:00:00Z",
      "createdBy": "user-123",
      "updatedDate": "2024-05-10T12:00:00Z",
      "updatedBy": "user-456"
    },
    "metadata": {
      "dateFormat": "yyyy-MM-dd",
      "dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
      "paginationToken": null
    }
  },
  "validationIssues": [],
  "messageToken": "createOrganisationPaymentConfigSuccess"
}

Documentation Index

Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

Path Parameters

​
payrollConfigId
string
required

Body

application/json
​
method
string
required
Example:

"BACS"

​
format
string
required
Example:

"Barclays"

​
fileFormat
string
default:txt

Optional. Defaults to txt when omitted. Use csv only when listed in supportedFileFormats for this method/format.

Example:

"csv"

​
reference
string | null

Single reference expression. Supports static text and tokens in any order: {payDate}, {payPeriodStart}, {payPeriodEnd}, {year}, {period}, {frequency}, {separator:space}, {separator:dash}, {separator:underscore}, {separator:slash}, {separator:custom:}.

Example:

"Payroll May 2024"

​
referenceDateFormat
enum<string> | null
default:DMY_SLASH

Optional date format enum applied to date tokens ({payDate}, {payPeriodStart}, {payPeriodEnd}). If omitted, the system defaults to DMY_SLASH(01/02/2026). Supported values: DMY_COMPACT(01022026), DMY_SLASH(01/02/2026), YMD_DASH(2026-02-01), MDY_SLASH(02/01/2026), DMY_DASH(01-02-2026), DMY_DOT(01.02.2026).

Available options:
DMY_COMPACT,
DMY_SLASH,
YMD_DASH,
MDY_SLASH,
DMY_DASH,
DMY_DOT
Example:

"DMY_SLASH"

​
bacs
object
Example:
{
  "sortCode": "12-34-56",
  "accountNumber": "12345678",
  "serviceUserNumber": "SUN123",
  "accountName": "ACME CORP LTD"
}

Response

Payment Configuration Created

​
message
object
​
content
object
​
validationIssues
object[]
​
messageToken
string