OrganisationPaymentConfig
Create payment configuration for an organisation
POST
/
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>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"method": "BACS",
"format": "Barclays",
"reference": "Salary{separator:space}{payDate}",
"referenceDateFormat": "DMY_COMPACT",
"bacs": {
"sortCode": "12-34-56",
"accountNumber": "12345678",
"serviceUserNumber": "SUN123"
}
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId}"
payload = {
"method": "BACS",
"format": "Barclays",
"reference": "Salary{separator:space}{payDate}",
"referenceDateFormat": "DMY_COMPACT",
"bacs": {
"sortCode": "12-34-56",
"accountNumber": "12345678",
"serviceUserNumber": "SUN123"
}
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
method: 'BACS',
format: 'Barclays',
reference: 'Salary{separator:space}{payDate}',
referenceDateFormat: 'DMY_COMPACT',
bacs: {sortCode: '12-34-56', accountNumber: '12345678', serviceUserNumber: 'SUN123'}
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'BACS',
'format' => 'Barclays',
'reference' => 'Salary{separator:space}{payDate}',
'referenceDateFormat' => 'DMY_COMPACT',
'bacs' => [
'sortCode' => '12-34-56',
'accountNumber' => '12345678',
'serviceUserNumber' => 'SUN123'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>",
"X-Org-Id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId}"
payload := strings.NewReader("{\n \"method\": \"BACS\",\n \"format\": \"Barclays\",\n \"reference\": \"Salary{separator:space}{payDate}\",\n \"referenceDateFormat\": \"DMY_COMPACT\",\n \"bacs\": {\n \"sortCode\": \"12-34-56\",\n \"accountNumber\": \"12345678\",\n \"serviceUserNumber\": \"SUN123\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId}")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"BACS\",\n \"format\": \"Barclays\",\n \"reference\": \"Salary{separator:space}{payDate}\",\n \"referenceDateFormat\": \"DMY_COMPACT\",\n \"bacs\": {\n \"sortCode\": \"12-34-56\",\n \"accountNumber\": \"12345678\",\n \"serviceUserNumber\": \"SUN123\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"BACS\",\n \"format\": \"Barclays\",\n \"reference\": \"Salary{separator:space}{payDate}\",\n \"referenceDateFormat\": \"DMY_COMPACT\",\n \"bacs\": {\n \"sortCode\": \"12-34-56\",\n \"accountNumber\": \"12345678\",\n \"serviceUserNumber\": \"SUN123\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}Authorizations
Access token obtained from OAuth2 client credentials flow
Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).
Path Parameters
Body
application/json
Example:
"BACS"
Example:
"Barclays"
Optional. Defaults to txt when omitted. Use csv only when listed in supportedFileFormats for this method/format.
Example:
"csv"
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"
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"
Show child attributes
Show child attributes
Example:
{
"sortCode": "12-34-56",
"accountNumber": "12345678",
"serviceUserNumber": "SUN123",
"accountName": "ACME CORP LTD"
}
Was this page helpful?
⌘I
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>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"method": "BACS",
"format": "Barclays",
"reference": "Salary{separator:space}{payDate}",
"referenceDateFormat": "DMY_COMPACT",
"bacs": {
"sortCode": "12-34-56",
"accountNumber": "12345678",
"serviceUserNumber": "SUN123"
}
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId}"
payload = {
"method": "BACS",
"format": "Barclays",
"reference": "Salary{separator:space}{payDate}",
"referenceDateFormat": "DMY_COMPACT",
"bacs": {
"sortCode": "12-34-56",
"accountNumber": "12345678",
"serviceUserNumber": "SUN123"
}
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
method: 'BACS',
format: 'Barclays',
reference: 'Salary{separator:space}{payDate}',
referenceDateFormat: 'DMY_COMPACT',
bacs: {sortCode: '12-34-56', accountNumber: '12345678', serviceUserNumber: 'SUN123'}
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'BACS',
'format' => 'Barclays',
'reference' => 'Salary{separator:space}{payDate}',
'referenceDateFormat' => 'DMY_COMPACT',
'bacs' => [
'sortCode' => '12-34-56',
'accountNumber' => '12345678',
'serviceUserNumber' => 'SUN123'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>",
"X-Org-Id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId}"
payload := strings.NewReader("{\n \"method\": \"BACS\",\n \"format\": \"Barclays\",\n \"reference\": \"Salary{separator:space}{payDate}\",\n \"referenceDateFormat\": \"DMY_COMPACT\",\n \"bacs\": {\n \"sortCode\": \"12-34-56\",\n \"accountNumber\": \"12345678\",\n \"serviceUserNumber\": \"SUN123\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId}")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"BACS\",\n \"format\": \"Barclays\",\n \"reference\": \"Salary{separator:space}{payDate}\",\n \"referenceDateFormat\": \"DMY_COMPACT\",\n \"bacs\": {\n \"sortCode\": \"12-34-56\",\n \"accountNumber\": \"12345678\",\n \"serviceUserNumber\": \"SUN123\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/payment/config/{payrollConfigId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"BACS\",\n \"format\": \"Barclays\",\n \"reference\": \"Salary{separator:space}{payDate}\",\n \"referenceDateFormat\": \"DMY_COMPACT\",\n \"bacs\": {\n \"sortCode\": \"12-34-56\",\n \"accountNumber\": \"12345678\",\n \"serviceUserNumber\": \"SUN123\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}