Penfold Partner API
GET /employers/{employerId}/payments
Bearer auth

Returns all bank transfer payments for the specified employer, including past (received) and upcoming (outstanding) payments. Use the status field to distinguish between them.

Path parameters

  • employerId string(uuid) Required

    Penfold employer UUID

Responses

  • 200 application/json

    List of payments

    Hide response attribute Show response attribute object
    • payments array[object] Required
      Hide payments attributes Show payments attributes object
      • id string Required

        Unique identifier for the payment

      • amountPence integer Required

        Total payment amount in pence

      • paymentReference string Required

        Bank transfer reference to use when making the payment. Format: {frequencyPrefix}{yyMMdd}{employerNumber}-{suffix} where frequencyPrefix is M(onthly)/W(eekly)/4(weekly)/2(weekly), date is the pay period start, and employer number is the external reference without the PEN prefix. Max 18 characters.

      • payPeriodStart string(date) Required

        Start date of the pay period this payment covers (ISO 8601 date)

      • payPeriodEnd string(date) Required

        End date of the pay period this payment covers (ISO 8601 date)

      • status string Required

        Whether Penfold has received this payment.

        Values are Outstanding or Received.

      • createdAt string(date-time) Required

        When the payment record was created (ISO 8601)
  • 401 application/json

    Missing or invalid authentication token

    Hide response attribute Show response attribute object
    • error string Required
  • 404 application/json

    Resource not found

    Hide response attribute Show response attribute object
    • error string Required
  • 500 application/json

    Internal server error

    Hide response attribute Show response attribute object
    • error string Required
GET /employers/{employerId}/payments 
curl \
 --request GET 'https://partner-api.getpenfold.com/v1/employers/{employerId}/payments' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "payments": [
    {
      "id": "p1a2b3c4-d5e6-7890-abcd-ef1234567890",
      "status": "Outstanding",
      "createdAt": "2025-03-15T10:00:00Z",
      "amountPence": 850000,
      "payPeriodEnd": "2025-03-31",
      "payPeriodStart": "2025-03-01",
      "paymentReference": "M25030112345678-ZG"
    },
    {
      "id": "p2b3c4d5-e6f7-8901-bcde-f12345678902",
      "status": "Received",
      "createdAt": "2025-02-15T10:00:00Z",
      "amountPence": 920000,
      "payPeriodEnd": "2025-02-28",
      "payPeriodStart": "2025-02-01",
      "paymentReference": "M25020112345678-AB"
    }
  ]
}
Response examples (401) 
{
  "error": "unauthorized"
}
Response examples (404) 
{
  "error": "not found"
}
Response examples (500) 
{
  "error": "internal server error"
}