New refund request

Server URLloading...

POST

/payments/{id}/request-refund

Send

Path

Header

Body

Refunds are only available when using Volt Connect

Usage

Pass the id of the existing payment in the URL and the amount and reference for the refund in the body of the request.

Checking eligibility before requesting a refund

You can get the eligibility for a refund using GET /payments/{id}/refund-details

More information

Full details on how to use refunds, with details of notifications you can expect, can be found in our comprehensive integration guides.

Path Parameters

Header Parameters

Details of the refund you'd like to request for this payment

Response Body

curl -X POST "https://connect-api-sandbox.volt.io/payments/93b85f3c-76eb-4316-b1ae-f3370ddc59bc/request-refund" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "93b85f3c-76eb-4316-b1ae-f3370ddc59bc"
}

{
  "exception": {
    "code": 403,
    "message": "Payouts are not enabled for your account"
  }
}

{
  "exception": {
    "code": 403,
    "message": "A resource has already been created with this idempotency key."
  }
}

{
  "exception": {
    "code": 422,
    "message": "You cannot send payouts to this beneficiary"
  }
}