Skip to main content
Create a Refund
curl --request POST \
  --url https://api.dots.dev/api/v2/refunds \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123,
  "payment_intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reason": "duplicate",
  "metadata": true
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
amount
integer
required

Amount in cents

Required range: x > 0
​
payment_intent_id
string<uuid>
required

ID of the payment_intent you are refunding.

​
reason
enum<string>
Available options:
duplicate,
fraudulent,
requested_by_customer,
expired_uncaptured_charge,
partial_capture
​
metadata
boolean

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Response

200 - application/json

OK

The refund object.

​
id
string<uuid>