Trigger a refund for an invoice or an adhoc invoice payment

post/refunds
SecuritybearerAuth
Request
Request Body schema: application/json

Create a refund for an invoice

invoiceId
integer <int64>

Invoice identifier

billRunType
string (BillRunType)

Bill run type

Enum: "NORMAL" "ADHOC"
description
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Refund description

paymentMethod
string (PaymentMethod)

Payment method

Enum: "CHEQUE" "DIRECT_DEBIT" "CANCELLED_DD" "CREDIT_CARD" "PAYPAL" "BACS" "POST_OFFICE_PAYMENT_CARD" "EZYPAY" "GO_CARDLESS" "GC_INSTANT_BANK_PAYMENTS" "STRIPE" "FINASTRA" "FAST_PAY" "OTHER"
amountInMajorCurrency
number [ 0.01 .. 100000 ]

Amount to refund in major currency (e.g pounds/dollars/euros)

Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples
application/json
{
  • "invoiceId": 1,
  • "billRunType": "NORMAL",
  • "description": "string",
  • "paymentMethod": "CHEQUE",
  • "amountInMajorCurrency": 10.5
}
Response samples
application/json
{
  • "id": 1,
  • "invoiceId": 1,
  • "customerId": 1,
  • "billRunType": "NORMAL",
  • "thirdPartyRefundStatus": "CREATED",
  • "description": "string",
  • "errorInfo": "string",
  • "paymentMethod": "CHEQUE",
  • "amountInMajorCurrency": 10.5
}