Skip to content
Recruso API

List payment methods

GET
/v1/reference/payment-methods
curl --request GET \
  --url https://api2.recruso.co.uk/v1/reference/payment-methods \
  --header 'Authorization: <Authorization>'

Returns every payment method the platform publishes. How a worker prefers to be paid. The values are BACS, Direct BACS, Cheque and Salary Payments.

These values are platform-wide: every agency sees the same list and the same ids, and your agency cannot add to them or change them. Use the id wherever a request asks for a payment method — paymentMethodId on CreateWorker.

The list is not paged, and no order is guaranteed — sort client-side if you need one. The values change very rarely, so cache them rather than fetching them before every call.

Access. Requires an authenticated token. No further policy is applied.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

Every payment method the platform publishes.

object
paymentMethods
required

The payment methods. Never null.

Array<object>

One payment method in a list.

object
id

The payment method’s identifier. Stable and platform-wide — the same id means the same thing for every agency.

integer format: int16
name

The payment method name, as it appears in Recruso. Up to 50 characters. Unique across all payment methods.

string
Example
{
  "paymentMethods": [
    {
      "id": 1,
      "name": "BACS"
    }
  ]
}

401

Section titled “401”

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}