Skip to main content
POST
/
api
/
v1
/
payments
/
{paymentId}
/
refund
Refund payment
curl --request POST \
  --url https://payments.coinbase.com/api/v1/payments/{paymentId}/refund \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "amount": "<string>",
  "metadata": {}
}
'
{
  "operationId": "<string>"
}

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:
{ "key": "value" }

Response

A successful response.

Response payload for payment refund requests.

​
operationId
string
required

Identifier for the payment operation.

Example:

"op-2341434"