Skip to main content
POST
Issue a claim token

Authorizations

Authorization
string
header
required

API token authentication using format <api token id>:<api client secret>

Path Parameters

claimablePayoutId
string
required

Unique identifier of the claimable payout

Response

Claim token issued

A claim token for the recipient's link. Grid keeps only its hash and shows it once: issuing another replaces it, so an earlier link stops working.

claimToken
string
required

The token to put in the link you send the recipient. Never log it or show it to the agent.

Example:

"2mJ0b7cX4lXzv1q3eRk8Wf6YtN9pHs5aUo-dGiCQwLE"

expiresAt
string<date-time>
required

When the payout's claim window ends.

Example:

"2025-10-10T15:00:00Z"