Skip to main content
GET
/
payment
/
config
/
{payrollConfigId}
Get payment configuration for an organisation
curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId} \
  --header 'X-Auth-Token: <api-key>'
{
  "message": {
    "text": "Payment configuration retrieved successfully",
    "token": "getOrganisationPaymentConfigSuccess",
    "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": "getOrganisationPaymentConfigSuccess"
}

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

Response

Payment Configuration Retrieved

message
object
content
object
validationIssues
object[]
messageToken
string