Skip to content

Elevate Payment and Refund API (1.37)

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
Download OpenAPI description
billing-rest-payment.json
billing-rest-payment.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

payment-providers

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

Operations

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)

Operations

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)

Operations

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

Operations

site-payment-mandates

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

Operations

payment-provider-mandates

Mandate details from the payment provider

Operations

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

Operations

customer-balances

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

Operations

Get the outstanding balance for a customer

Request

Security
bearerAuth
Query
customer_idinteger(int64)(IdParam)>= 1required

Customer identifier

Example: customer_id=1
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/customer-balances?customer_id=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Customer outstanding balance found

Bodyapplication/json
idinteger(int64)read-only

Customer outstanding balance identifier

Example: 1
customerIdinteger(int32)required

Customer identifier

Example: 1
balancenumber

Outstanding balance

totalPaymentsnumberread-only

Sum of all payments against the customer

totalPaymentsSinceLastInvoicenumberread-only

Sum of all payments against the customer since the last invoice

paymentMethodSummaryobject(PaymentMethodSummary)

Summary of customer's payment method. This is from a site that is 'live', meaning has no end date, or end date is in the future.

repaymentPlanSummaryobject(RepaymentPlanSummary)

Summary of customer's repayment plan. This is from a site that is 'live', meaning has no end date, or end date is in the future.

Response
application/json
{
  "id": 1,
  "customerId": 1,
  "balance": 0,
  "totalPayments": 0,
  "totalPaymentsSinceLastInvoice": 0,
  "paymentMethodSummary": {
    "paymentMethod": "CHEQUE",
    "summaryType": "NONE"
  },
  "repaymentPlanSummary": {
    "repaymentPlanAmount": 1,
    "repaymentPlanRemainingPeriods": 0,
    "summaryType": "NONE"
  }
}

Make a manual adjustment to a customer's outstanding balance

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New customer balance adjustment

customerIdinteger(int32)required

Customer identifier

Example: 1
amountInMajorCurrencynumber[ -100000 .. 100000 ]required

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

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

Adjustment description

curl -i -X POST \
  https://rest.elevatebilling.com/v1/customer-balance-adjustments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "customerId": 1,
    "amountInMajorCurrency": 10.5,
    "description": "string"
  }'

Responses

Customer balance adjusted

Bodyapplication/json
idinteger(int64)read-only

Customer balance adjustment identifier

Example: 1
customerIdinteger(int32)required

Customer identifier

Example: 1
amountInMajorCurrencynumber[ -100000 .. 100000 ]required

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

Example: 10.5
currencyIdinteger(int64)read-only

Currency Id

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

Adjustment description

Response
application/json
{
  "id": 1,
  "customerId": 1,
  "amountInMajorCurrency": 10.5,
  "currencyId": 1,
  "description": "string"
}

customer-credit-status

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

Operations

payment-provider-reprocess

Synchronise Elevate payment statuses by reprocessing payment provider events

Operations

invoice-payment-reprocess

Reprocess a normal or adhoc invoice payment

Operations

invoice-payment-cancel

Cancel a pending payment collection

Operations

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

Operations