# Elevate Payment and Refund API

### Payment Management
Provides read & write access to payment entities.

#### Definitions
* PaymentProvider - a representation of a system that Elevate will interoperate with to collect payments, e.g. Go Cardless 
* SitePaymentMandate - a token from the payment provider that gives authority to take a direct debit from a bank account 
* InvoicePayment - a single payment for an invoice that has happened externally or passed to a payment provider to collect funds
* AdhocInvoicePayment - a single payment for an adhoc invoice that has happened externally or passed to a payment provider to collect funds
* Refund - the funds returned to the customer that have previously been collected
* CustomerPayments - a single payment to an invoice or customer outstanding balance
* CustomerOutstandingBalance - the amount a customer is in debt (if negative) or has in credit (if positive)
* CustomerCreditStatus - returns a customer balance versus their credit threshold
* PaymentProviderPaymentLink - An external hyperlink that allows a customer to pay for an invoice or any amount towards the customer balance


Version: 1.37

## Servers

```
https://rest.elevatebilling.com/v1
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Elevate Payment and Refund API](https://docs.elevatebilling.com/_bundle/openapi/prod/gen/billing-rest-payment.yaml)

## payment-providers

A representation of a system that Elevate will interoperate with to collect payments, e.g. Go Cardless or Finastra

### Get a list of payment providers

 - [GET /payment-providers](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/payment-providers/getpaymentproviders.md)

### Create a payment provider

 - [POST /payment-providers](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/payment-providers/createpaymentprovider.md)

### Get a specific payment provider

 - [GET /payment-providers/{payment_provider_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/payment-providers/getpaymentprovider.md)

### Update the payment provider

 - [PATCH /payment-providers/{payment_provider_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/payment-providers/updatepaymentprovider.md)

## invoice-payments

An event related to a normal invoice payment (For example a manual payment, a successful submission to a third party payment provider, or an update received back)

### Get a list of available invoice payment events

 - [GET /invoice-payments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/invoice-payments/getinvoicepayments.md)

### Create a new invoice payment

 - [POST /invoice-payments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/invoice-payments/createinvoicepayment.md)

### Get a specific invoice payment event

 - [GET /invoice-payments/{invoice_payment_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/invoice-payments/getinvoicepayment.md)

## adhoc-invoice-payments

An event related to an adhoc invoice payment (For example a manual payment, a successful submission to a third party payment provider, or a status update received back)

### Get a list of available adhoc invoice payments

 - [GET /adhoc-invoice-payments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/adhoc-invoice-payments/getadhocinvoicepayments.md)

### Create a new adhoc invoice payment

 - [POST /adhoc-invoice-payments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/adhoc-invoice-payments/createadhocinvoicepayment.md)

### Get a specific adhoc invoice payment

 - [GET /adhoc-invoice-payments/{adhoc_invoice_payment_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/adhoc-invoice-payments/getadhocinvoicepayment.md)

## refunds

Refunds represent the funds returned to the customer that have previously been collected. If the payment method is left blank or the invoice is auto collected, then same payment method of the last successful payment will be used

### Get a list of refunds

 - [GET /refunds](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/refunds/getrefunds.md)

### Trigger a refund for an invoice or an adhoc invoice payment

 - [POST /refunds](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/refunds/createrefund.md)

## site-payment-mandates

A token from the payment provider that gives authority to take a direct debit from a bank account

### Get a list of site payment mandates

 - [GET /site-payment-mandates](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/site-payment-mandates/getsitepaymentmandates.md)

### Create a new site payment mandate

 - [POST /site-payment-mandates](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/site-payment-mandates/createsitepaymentmandate.md)

## payment-provider-mandates

Mandate details from the payment provider

### Get details of a mandate

 - [GET /payment-provider-mandates/{paymentMethod}/{mandateReference}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/payment-provider-mandates/getpaymentprovidermandate.md): Get details of a mandate for a given payment provider

## customer-payments

A payment against a customer. The amount will be used to pay off any unpaid invoices starting from the oldest first. Overpayments will be added to the customer-balance

### Get a list of customer or invoice payments

 - [GET /customer-payments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/customer-payments/getcustomerpayments.md)

### Create a new customer payment

 - [POST /customer-payments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/customer-payments/createcustomerpayment.md): Create a new customer payment to be disbursed to invoices and/or customer's outstanding balance

### Get a specific customer payment

 - [GET /customer-payments/{customer_payment_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/customer-payments/getcustomerpayment.md)

## customer-balances

The customer's outstanding balance. Negative means a debt, Positive means they have credit

### Get the outstanding balance for a customer

 - [GET /customer-balances](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/customer-balances/getcustomerbalance.md)

### Make a manual adjustment to a customer's outstanding balance

 - [POST /customer-balance-adjustments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/customer-balances/createcustomerbalanceadjustment.md)

## customer-credit-status

The customer's credit status - returns current balance versus their credit threshold

### Get a list of credit status threshold information

 - [GET /customer-credit-status](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/customer-credit-status/getcustomercreditstatus.md): Get a list of credit status threshold information for customers including customer balance and open bill values

## payment-provider-payment-link

An external hyperlink that allows a customer to pay for a normal/adhoc invoice or towards the customer balance

### Create a new payment link

 - [POST /payment-provider-payment-link](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/payment-provider-payment-link/createpaymentproviderpaymentlink.md): Create a new payment link for an invoice, adhoc invoice or customer

## payment-provider-reprocess

Synchronise Elevate payment statuses by reprocessing payment provider events

### Synchronise Elevate payment statuses

 - [POST /payment-provider-reprocess](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/payment-provider-reprocess/paymentproviderreprocess.md): Synchronise Elevate payment statuses by reprocessing payment provider events

## invoice-payment-reprocess

Reprocess a normal or adhoc invoice payment

### Reprocess an invoice payment

 - [POST /invoice-payment-reprocess](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/invoice-payment-reprocess/reprocessinvoicepayment.md)

## invoice-payment-cancel

Cancel a pending payment collection

### Cancel an invoice payment

 - [POST /invoice-payment-cancel](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/invoice-payment-cancel/cancelinvoicepayment.md)

## instant-bank-payment-for-mandate

An instant first payment—typically made via Instant Bank Payment—processed as part of the mandate creation flow. Currently supported only when using the GoCardless payment provider

### Get the instant bank payment for a mandate

 - [GET /instant-bank-payment-for-mandate](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-payment/instant-bank-payment-for-mandate/getinstantbankpaymentformandate.md)