Skip to main content
POST
Distribute rewards

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Learn more about JWT tokens in the Coinbase Developer Portal.

Headers

x-idempotency-key
string
required

Unique identifier to ensure request idempotency

Body

application/json

Request payload for distributing rewards.

Request payload for distributing rewards.

paymentOperationId
string
required

The ID of the payment operation to associate rewards with.

Example:

"op-123456"

rewards
RewardInput · object[]
required

List of rewards to process.

Example:
metadata
Metadata · object

Metadata for the reward operations that will be returned in the webhook.

Example:

Response

A successful response.

Response payload for distributing rewards.

rewardOperations
RewardOperation · object[]

List of successful reward operations with detailed information.

Example:
invalidRewardInputs
InvalidRewardInput · object[]

List of reward inputs that were invalid/unable to be processed with detailed reasoning.

Example: