Skip to main content
POST
Refund 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 refund.

Body

application/json

Request payload for refunding a payment using the payment ID.

amount
string
required

Amount to refund (must be less than or equal to the captured/charged amount).

Example:

"50.00"

metadata
Metadata · object

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

Example:

Response

A successful response.

Response payload for payment refund requests.

operationId
string
required

Identifier for the payment operation.

Example:

"op-2341434"