Create a refund

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Payment Refund Parameters

Parameter Type Default Value Description
paymentId string required The id of the payment.
amount string 20.00 The amount of the refund.
currency string USD The currency for the refund
meta json {} Optional key/values to link the refund to an external system
description string A description for the refund A short description for the refund

Example cURL Request

curl --request POST \
     --url https://api.paystand.co/v3/payments/required/refunds \
     --header 'Accept: ••••' \
     --header 'Authorization: Bearer ••••' \
     --header 'Content-Type: ••••' \
     --header 'X-CUSTOMER-ID: ••••' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "amount": "20.00",
  "currency": "USD",
  "meta": {},
  "description": "A description for the refund"
}
'```

### API Response

```json
{
  "status": "200",  
  "message": "Refund processed successfully."
}