Logo
GoCardless API API Documentation

Create a Refund

POST {{url}}/refunds

Creates a new refund object.

Create a Refund API Docs

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




RESPONSES

status Created

{ "refunds": { "id": "RF00006Y45GPXN", "amount": 2399, "created_at": "2024-03-22T20:28:37.945Z", "reference": "refund", "metadata": { "reason": "late delivery" }, "currency": "USD", "status": "created", "fx": { "fx_currency": null, "fx_amount": null, "exchange_rate": null, "estimated_exchange_rate": null }, "links": { "payment": "PM009MNY1M77CK", "mandate": "MD000ZQT5CPCVV" } } }



Curl
curl -X POST 'https://api-sandbox.gocardless.com/refunds' -d '{"refunds":{"amount":2399,"total_amount_confirmation":2399,"reference":"refund","metadata":{"reason":"late delivery"},"links":{"payment":"payment"}}}'

ENDPOINTS