Issue a claim token

Issue the claim token for the recipient’s link to a payout that is AWAITING_CLAIM. Grid stores only its hash, so it is returned once; issuing another, for a reminder, replaces it and the earlier link stops working. Put it in a link to your own claim page and send it to the payout’s recipient.phoneNumber or recipient.email. Never show it to the agent.

POST /claimable-payouts/{claimablePayoutId}/claim-token

Issue a claim token

cURL

curl --request POST \
  --url https://api.lightspark.com/grid/2025-10-13/claimable-payouts/{claimablePayoutId}/claim-token \
  --header 'Authorization: Basic <encoded-value>'

201

{
  "claimToken": "2mJ0b7cX4lXzv1q3eRk8Wf6YtN9pHs5aUo-dGiCQwLE",
  "expiresAt": "2025-10-10T15:00:00Z"
}

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

201

application/json

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"