Create DSP Refund Request

POST {{base_url}}/v3/refunds

Required scope: refunds:write

Creates a new DSP refund request. Requires admin, partner, or vendor authentication.

Request body

{
  "amount": 15.5,
  "contact_email": "customer@example.com",
  "description": "Food was cold and delivery was late",
  "external_dsps_id": "dsp_delivery_12345",
  "external_dsps_name": "DoorDash",
  "issue_type": "food_quality",
  "merchant_name": "Joe's Pizza",
  "internal_status": "unreviewed"
}

Examples

cURL

curl --request POST '${base_url}/v3/refunds' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{auth_token}}' \
  --data '{
  "amount": 15.5,
  "contact_email": "customer@example.com",
  "description": "Food was cold and delivery was late",
  "external_dsps_id": "dsp_delivery_12345",
  "external_dsps_name": "DoorDash",
  "issue_type": "food_quality",
  "merchant_name": "Joe'\''s Pizza",
  "internal_status": "unreviewed"
}'

Node.js

const response = await fetch("${base_url}/v3/refunds", {
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{auth_token}}"
  },
  "body": "{\n  \"amount\": 15.5,\n  \"contact_email\": \"customer@example.com\",\n  \"description\": \"Food was cold and delivery was late\",\n  \"external_dsps_id\": \"dsp_delivery_12345\",\n  \"external_dsps_name\": \"DoorDash\",\n  \"issue_type\": \"food_quality\",\n  \"merchant_name\": \"Joe's Pizza\",\n  \"internal_status\": \"unreviewed\"\n}"
})
const data = await response.json()

Python

import requests

response = requests.request(
    "POST",
    "${base_url}/v3/refunds",
    headers={
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{auth_token}}'
},
    data="{\n  \"amount\": 15.5,\n  \"contact_email\": \"customer@example.com\",\n  \"description\": \"Food was cold and delivery was late\",\n  \"external_dsps_id\": \"dsp_delivery_12345\",\n  \"external_dsps_name\": \"DoorDash\",\n  \"issue_type\": \"food_quality\",\n  \"merchant_name\": \"Joe's Pizza\",\n  \"internal_status\": \"unreviewed\"\n}",
)
response.raise_for_status()

Saved responses

200 Success Response

{
  "success": true,
  "data": {
    "id": "refund_12345",
    "amount": 15.5,
    "contact_email": "customer@example.com",
    "description": "Food was cold and delivery was late",
    "external_dsps_id": "dsp_delivery_12345",
    "external_dsps_name": "DoorDash",
    "issue_type": "food_quality",
    "merchant_name": "Joe's Pizza",
    "internal_status": "unreviewed",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}