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

Get a list of site payment mandates

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
siteIdinteger(int64)(IdParam)>= 1

Filter by site id

Example: siteId=1
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/site-payment-mandates?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&siteId=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Site payment mandate identifier

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

URL to the site payment provider to give to end users

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

token from payment provider to confirm mandate

siteIdinteger(int64)required

Site identifier

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

URL the payment provider will redirect the browser to at the end of their data collection process

mandateReferencestring[ 0 .. 255 ] charactersread-only

Mandate reference. Required when the paymentType is an integrated one, for example GO_CARDLESS, FINASTRA or STRIPE. If GO_CARDLESS, only accepted Created, Pending Submission, Submitted, Active, Reinstated, Customer approval granted and Customer approval skipped

thirdPartyCustomerReferencestring[ 0 .. 255 ] charactersread-only

Reference to a customer in a third party system. For example, Stripe Customer ID (mandatory if a Stripe mandate is provided), or optional references like GO_CARDLESS Customer Reference or FINASTRA Account Number

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

URL to an alternative payment page when payment provider unavailable

]
Response
application/json
[
  {
    "id": 1,
    "redirectURL": "string",
    "flowToken": "string",
    "siteId": 1,
    "returnURL": "string",
    "mandateReference": "string",
    "thirdPartyCustomerReference": "string",
    "exitURL": "string"
  }
]

Create a new site payment mandate

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New site payment mandate

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

URL to the site payment provider to give to end users

siteIdinteger(int64)required

Site identifier

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

URL the payment provider will redirect the browser to at the end of their data collection process

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

URL to an alternative payment page when payment provider unavailable

curl -i -X POST \
  https://rest.elevatebilling.com/v1/site-payment-mandates \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "redirectURL": "string",
    "siteId": 1,
    "returnURL": "string",
    "exitURL": "string"
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Site payment mandate identifier

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

URL to the site payment provider to give to end users

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

token from payment provider to confirm mandate

siteIdinteger(int64)required

Site identifier

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

URL the payment provider will redirect the browser to at the end of their data collection process

mandateReferencestring[ 0 .. 255 ] charactersread-only

Mandate reference. Required when the paymentType is an integrated one, for example GO_CARDLESS, FINASTRA or STRIPE. If GO_CARDLESS, only accepted Created, Pending Submission, Submitted, Active, Reinstated, Customer approval granted and Customer approval skipped

thirdPartyCustomerReferencestring[ 0 .. 255 ] charactersread-only

Reference to a customer in a third party system. For example, Stripe Customer ID (mandatory if a Stripe mandate is provided), or optional references like GO_CARDLESS Customer Reference or FINASTRA Account Number

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

URL to an alternative payment page when payment provider unavailable

Response
application/json
{
  "id": 1,
  "redirectURL": "string",
  "flowToken": "string",
  "siteId": 1,
  "returnURL": "string",
  "mandateReference": "string",
  "thirdPartyCustomerReference": "string",
  "exitURL": "string"
}

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

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