Skip to main content
POST

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Body

application/json

Rewards you have paid.

Rewards you have paid. Provide exactly one of reward_ids or filter.

reward_ids
string[]

Reward entry IDs to mark paid. Each must be APPROVED.

Minimum array length: 1
Example:
filter
object

Mark every APPROVED entry this matches as paid, in one call. Selects entries the same way the filters on list all rewards do. Give at least one field.

Example:
payment_reference
string

Your reference for the payment, stored on each entry the call marks paid. For payments made one at a time, call once per payment with that payment's entry and reference.

Example:

"PAY-2026-09-000184"

Response

Reward batch response.

The result of approving rewards or marking them paid.

object
enum<string>
required

Object type, reward_batch.

Available options:
reward_batch
Example:

"reward_batch"

status
enum<string>
required

The status the entries were moved to.

Available options:
APPROVED,
PAID
Example:

"PAID"

count
integer
required

Number of entries this call changed. Entries that were already in this status, or past it, are not counted.

Required range: x >= 0
Example:

1840