Skip to main content
POST
Void payment

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

Path Parameters

paymentId
string
required

The unique identifier of the payment to void.

Body

application/json

Request payload for voiding a payment using the payment ID. This simplified endpoint fetches payment details from the database.

metadata
Metadata · object

Metadata for the payment operation that will be returned in the webhook.

Example:
deallocateRewards
RewardInput · object[]

List of rewards to deallocate during payment void.

Example:

Response

A successful response.

Response payload for payment void requests.

operationId
string
required

Identifier for the payment operation.

Example:

"op-2341434"

rewardOperations
RewardOperation · object[]

List of reward operations with detailed information, if rewards were processed.

Example:
invalidRewardInputs
InvalidRewardInput · object[]

List of rewards that were invalid/unable to be processed with detailed reasoning

Example: