# Trigger a refund for an invoice or an adhoc invoice payment Endpoint: POST /refunds Version: 1.37 Security: bearerAuth ## Request fields (application/json): - `invoiceId` (integer) Invoice identifier Example: 1 - `billRunType` (string) Bill run type Enum: "NORMAL", "ADHOC" - `description` (string) Refund description - `paymentMethod` (string) Payment method Enum: "CHEQUE", "DIRECT_DEBIT", "CANCELLED_DD", "CANCELLED_CARD", "CREDIT_CARD", "PAYPAL", "BACS", "POST_OFFICE_PAYMENT_CARD", "EZYPAY", "GO_CARDLESS", "GC_INSTANT_BANK_PAYMENTS", "STRIPE", "STRIPE_CARD", "STRIPE_DD", "FINASTRA", "FAST_PAY", "OTHER" - `amountInMajorCurrency` (number) Amount to refund in major currency (e.g pounds/dollars/euros) Example: 10.5 ## Response 200 fields (application/json): - `id` (integer) Refund identifier Example: 1 - `invoiceId` (integer) Invoice identifier Example: 1 - `customerId` (integer) Customer identifier Example: 1 - `billRunType` (string) Bill run type Enum: "NORMAL", "ADHOC" - `thirdPartyRefundStatus` (string) Third party refund status Enum: "CREATED", "PENDING_SUBMISSION", "SUBMITTED", "PAID", "CANCELLED", "BOUNCED", "FUNDS_RETURNED", "MANUALLY_REFUNDED", "REFUND_SETTLED" - `description` (string) Refund description - `errorInfo` (string) Error information from third party payment provider - `paymentMethod` (string) Payment method Enum: "CHEQUE", "DIRECT_DEBIT", "CANCELLED_DD", "CANCELLED_CARD", "CREDIT_CARD", "PAYPAL", "BACS", "POST_OFFICE_PAYMENT_CARD", "EZYPAY", "GO_CARDLESS", "GC_INSTANT_BANK_PAYMENTS", "STRIPE", "STRIPE_CARD", "STRIPE_DD", "FINASTRA", "FAST_PAY", "OTHER" - `amountInMajorCurrency` (number) Amount to refund in major currency (e.g pounds/dollars/euros) Example: 10.5 ## Response 201 fields (application/json): - `id` (integer) Refund identifier Example: 1 - `invoiceId` (integer) Invoice identifier Example: 1 - `customerId` (integer) Customer identifier Example: 1 - `billRunType` (string) Bill run type Enum: "NORMAL", "ADHOC" - `thirdPartyRefundStatus` (string) Third party refund status Enum: "CREATED", "PENDING_SUBMISSION", "SUBMITTED", "PAID", "CANCELLED", "BOUNCED", "FUNDS_RETURNED", "MANUALLY_REFUNDED", "REFUND_SETTLED" - `description` (string) Refund description - `errorInfo` (string) Error information from third party payment provider - `paymentMethod` (string) Payment method Enum: "CHEQUE", "DIRECT_DEBIT", "CANCELLED_DD", "CANCELLED_CARD", "CREDIT_CARD", "PAYPAL", "BACS", "POST_OFFICE_PAYMENT_CARD", "EZYPAY", "GO_CARDLESS", "GC_INSTANT_BANK_PAYMENTS", "STRIPE", "STRIPE_CARD", "STRIPE_DD", "FINASTRA", "FAST_PAY", "OTHER" - `amountInMajorCurrency` (number) Amount to refund in major currency (e.g pounds/dollars/euros) Example: 10.5 ## Response 400 fields ## Response 401 fields ## Response 403 fields