Get payment file for a pay run

curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/payment/file/run/{payrollConfigId}/year/{year}/frequency/{frequency}/period/{period} \
  --header 'X-Auth-Token: <api-key>' \
  --header 'X-Org-Id: <api-key>'

import requests

url = "https://api.sandbox.flowpayroll.ai/v1/payment/file/run/{payrollConfigId}/year/{year}/frequency/{frequency}/period/{period}"

headers = {
    "X-Auth-Token": "<api-key>",
    "X-Org-Id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>', 'X-Org-Id': '<api-key>'}};

fetch('https://api.sandbox.flowpayroll.ai/v1/payment/file/run/{payrollConfigId}/year/{year}/frequency/{frequency}/period/{period}', 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/file/run/{payrollConfigId}/year/{year}/frequency/{frequency}/period/{period}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.flowpayroll.ai/v1/payment/file/run/{payrollConfigId}/year/{year}/frequency/{frequency}/period/{period}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Auth-Token", "<api-key>")
	req.Header.Add("X-Org-Id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.flowpayroll.ai/v1/payment/file/run/{payrollConfigId}/year/{year}/frequency/{frequency}/period/{period}")
  .header("X-Auth-Token", "<api-key>")
  .header("X-Org-Id", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.flowpayroll.ai/v1/payment/file/run/{payrollConfigId}/year/{year}/frequency/{frequency}/period/{period}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {
      "organisationId": "01K1BKF2MJC2WPNP38V3VVQ94C",
      "payrollConfigId": "01KMKX9ZBHS65ZWGV2266K0S8K",
      "year": 2025,
      "frequency": "Weekly",
      "period": 25,
      "status": "GENERATED",
      "format": {
        "paymentMethod": "BACS",
        "paymentFormat": "Standard18"
      },
      "summary": {
        "totalRecords": 15,
        "employeeCount": 8,
        "totalAmount": 6268.12
      },
      "file": {
        "name": "Acme_Ltd_Payment File 2025 Weekly 25 - 20260515-215906.txt",
        "size": 2279,
        "downloadUrl": "https://example.com/signed-url",
        "downloadUrlExpiresAt": "2026-05-22T21:59:06Z"
      },
      "failure": null,
      "externalReference": null,
      "createdDate": "2026-05-15T21:59:06+00:00",
      "createdBy": "SYSTEM"
    },
    "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>"
}

{
  "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>"
}