Skip to content

Elevate Payment and Refund API (1.41)

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

Get details of a mandate

Request

Get details of a mandate for a given payment provider

Security
bearerAuth
Path
paymentMethodstring(PaymentMethod)required

Payment Method

Enum"CHEQUE""DIRECT_DEBIT""CANCELLED_DD""CANCELLED_CARD""CREDIT_CARD""PAYPAL""BACS""POST_OFFICE_PAYMENT_CARD""EZYPAY""GO_CARDLESS"
mandateReferencestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Mandate reference

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

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

contractOwnerIdinteger(int64)(IdParam)>= 1

Filter by contract owner id

Example: contractOwnerId=1
customerIdinteger(int64)(IdParam)>= 1

The customer the mandate reference is validated against when checkSharedMandate is true. Omit it to fail when any customer holds the mandate. Ignored when checkSharedMandate is false

Example: customerId=1
checkSharedMandateboolean

When true, the mandate reference is validated against customerId and the request fails with 400 if a different customer already holds it on one of its sites. Only applies when the payment provider has Accept External Payments enabled, because external payments are matched to a customer through the mandate and so a mandate cannot be shared across customers. Mandates in a cancelled, expired, failed or inactive state are ignored

Default false
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/payment-provider-mandates/{paymentMethod}/{mandateReference}?thirdPartyCustomerReference=string&contractOwnerId=1&customerId=1&checkSharedMandate=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Payment provider mandate

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

Mandate reference. If GO_CARDLESS, only accepted Created, Pending Submission, Submitted, Active, Reinstated, Customer approval granted and Customer approval skipped

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

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

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

Created at

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

Email address

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

First name

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

Last name

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

Company name

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

Address line 1

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

Address line 2

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

Address line 3

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

City

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

Region

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

Postcode

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

Country code

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

Telephone number

statusstring(PaymentProviderMandateStatus)

Invoice payment status

Enum"NEW""INACTIVE""CREATED""CUSTOMER_APPROVAL_GRANTED""CUSTOMER_APPROVAL_SKIPPED""ACTIVE""CANCELLED""FAILED""TRANSFERRED""EXPIRED"
Response
application/json
{
  "mandateReference": "string",
  "thirdPartyCustomerReference": "string",
  "createdAt": "string",
  "emailAddress": "string",
  "firstName": "string",
  "lastName": "string",
  "companyName": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "city": "string",
  "region": "string",
  "postcode": "string",
  "countryCode": "string",
  "telephoneNumber": "string",
  "status": "NEW"
}

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

outbound-payments

Outbound Payments are API-managed payouts that let you send money from your payment account to a recipient’s bank account (e.g., customers, suppliers, or third parties). They represent a payment initiated by the creditor and tracked through statuses like verifying, pending approval, scheduled, and executed

Operations