Skip to content

Get payment method details

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

Returns one payment method by id. How a worker prefers to be paid. The values are BACS, Direct BACS, Cheque and Salary Payments.

Payment methods are platform-wide, so an id means the same payment method for every agency.

An id that does not match a payment method returns 404.

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

id
required
integer format: int32

The id path parameter

OK

Media typeapplication/json

One payment method.

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
{
"id": 1,
"name": "BACS"
}

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

Not Found

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