Skip to content

Elevate Payment and Refund API (1.39)

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

Get a list of customer or invoice payments

Request

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

Customer identifier

Example: customer_id=1
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
filterstring(StringFilterParam)

Filter by text

Example: filter=xyz | in:x,y | like:xyz
customerPaymentTypestring(StringFilterParam)

Filter by customer payment type

Example: customerPaymentType=xyz | in:x,y | like:xyz
excludeDebitsstring(StringFilterParam)

Filter out negative payments

Example: excludeDebits=xyz | in:x,y | like:xyz
excludeCreditsstring(StringFilterParam)

Filter out zero and positive payments

Example: excludeCredits=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/customer-payments?customer_id=1&page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&filter=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&customerPaymentType=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&excludeDebits=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&excludeCredits=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Customer Payment identifier

Example: 1
customerIdinteger(int32)required

Customer identifier

Example: 1
amountInMajorCurrencynumber[ 0.01 .. 9999999.99 ]required

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

Example: 10.5
resultingCustomerBalancenumber[ 0.01 .. 9999999.99 ]read-only

customer balance after transaction has been applied in major currency (e.g pounds/dollars/euros)

Example: 10.5
currencyIdinteger(int64)read-onlyrequired

Currency Id

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

Payment description

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

Payment reference from third party payment system

typestring(PaymentMethod)required

Payment method

Enum"CHEQUE""DIRECT_DEBIT""CANCELLED_DD""CANCELLED_CARD""CREDIT_CARD""PAYPAL""BACS""POST_OFFICE_PAYMENT_CARD""EZYPAY""GO_CARDLESS"
paymentDatestring(date)read-only

When payment was made

customerPaymentTypestring(CustomerPaymentType)read-only

Type of payment

Enum"CUSTOMER""NORMAL_INVOICE""ADHOC_INVOICE""ADJUSTMENT""OUTBOUND_PAYMENT"
txnTypestring(TxnType)read-only

Type of transaction

Enum"INVOICE_CREATED""INVOICE_DISPUTED""INVOICE_WRITTEN_OFF""INVOICE_UNDISPUTED""INVOICE_UNWRITTEN_OFF""INVOICE_REFUNDED""INVOICE_CHARGED_BACK""INVOICE_PAYMENT""CUSTOMER_PAYMENT""BALANCE_ADJUSTMENT"
invoiceNumberstringread-only

Invoice Number

invoiceIdinteger(int64)read-only

Invoice identifier

Example: 0
billRunTypestring(BillRunType)

Bill run type

Enum"NORMAL""ADHOC"
inFlightbooleanread-only

is this customer payment 'in flight' meaning is it temporary and has yet to complete. These records are informational and should be replaced with success or failure records later

Default false
]
Response
application/json
[
  {
    "id": 1,
    "customerId": 1,
    "amountInMajorCurrency": 10.5,
    "resultingCustomerBalance": 10.5,
    "currencyId": 1,
    "description": "string",
    "reference": "string",
    "type": "CHEQUE",
    "paymentDate": "2019-08-24",
    "customerPaymentType": "CUSTOMER",
    "txnType": "INVOICE_CREATED",
    "invoiceNumber": "string",
    "invoiceId": 0,
    "billRunType": "NORMAL",
    "inFlight": false
  }
]

Create a new customer payment

Request

Create a new customer payment to be disbursed to invoices and/or customer's outstanding balance

Security
bearerAuth
Bodyapplication/jsonrequired

New customer payment

customerIdinteger(int32)required

Customer identifier

Example: 1
amountInMajorCurrencynumber[ 0.01 .. 9999999.99 ]required

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

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

Payment description

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

Payment reference from third party payment system

typestring(PaymentMethod)required

Payment method

Enum"CHEQUE""DIRECT_DEBIT""CANCELLED_DD""CANCELLED_CARD""CREDIT_CARD""PAYPAL""BACS""POST_OFFICE_PAYMENT_CARD""EZYPAY""GO_CARDLESS"
billRunTypestring(BillRunType)

Bill run type

Enum"NORMAL""ADHOC"
curl -i -X POST \
  https://rest.elevatebilling.com/v1/customer-payments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "customerId": 1,
    "amountInMajorCurrency": 10.5,
    "description": "string",
    "reference": "string",
    "type": "CHEQUE",
    "billRunType": "NORMAL"
  }'

Responses

Customer payment created

Bodyapplication/json
idinteger(int64)read-only

Customer Payment identifier

Example: 1
customerIdinteger(int32)required

Customer identifier

Example: 1
amountInMajorCurrencynumber[ 0.01 .. 9999999.99 ]required

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

Example: 10.5
resultingCustomerBalancenumber[ 0.01 .. 9999999.99 ]read-only

customer balance after transaction has been applied in major currency (e.g pounds/dollars/euros)

Example: 10.5
currencyIdinteger(int64)read-onlyrequired

Currency Id

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

Payment description

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

Payment reference from third party payment system

typestring(PaymentMethod)required

Payment method

Enum"CHEQUE""DIRECT_DEBIT""CANCELLED_DD""CANCELLED_CARD""CREDIT_CARD""PAYPAL""BACS""POST_OFFICE_PAYMENT_CARD""EZYPAY""GO_CARDLESS"
paymentDatestring(date)read-only

When payment was made

customerPaymentTypestring(CustomerPaymentType)read-only

Type of payment

Enum"CUSTOMER""NORMAL_INVOICE""ADHOC_INVOICE""ADJUSTMENT""OUTBOUND_PAYMENT"
txnTypestring(TxnType)read-only

Type of transaction

Enum"INVOICE_CREATED""INVOICE_DISPUTED""INVOICE_WRITTEN_OFF""INVOICE_UNDISPUTED""INVOICE_UNWRITTEN_OFF""INVOICE_REFUNDED""INVOICE_CHARGED_BACK""INVOICE_PAYMENT""CUSTOMER_PAYMENT""BALANCE_ADJUSTMENT"
invoiceNumberstringread-only

Invoice Number

invoiceIdinteger(int64)read-only

Invoice identifier

Example: 0
billRunTypestring(BillRunType)

Bill run type

Enum"NORMAL""ADHOC"
inFlightbooleanread-only

is this customer payment 'in flight' meaning is it temporary and has yet to complete. These records are informational and should be replaced with success or failure records later

Default false
Response
application/json
{
  "id": 1,
  "customerId": 1,
  "amountInMajorCurrency": 10.5,
  "resultingCustomerBalance": 10.5,
  "currencyId": 1,
  "description": "string",
  "reference": "string",
  "type": "CHEQUE",
  "paymentDate": "2019-08-24",
  "customerPaymentType": "CUSTOMER",
  "txnType": "INVOICE_CREATED",
  "invoiceNumber": "string",
  "invoiceId": 0,
  "billRunType": "NORMAL",
  "inFlight": false
}

Get a specific customer payment

Request

Security
bearerAuth
Path
customer_payment_idinteger(int64)(IdParam)>= 1required

Customer payment identifier

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

Responses

Payment provider found

Bodyapplication/json
idinteger(int64)read-only

Customer Payment identifier

Example: 1
customerIdinteger(int32)required

Customer identifier

Example: 1
amountInMajorCurrencynumber[ 0.01 .. 9999999.99 ]required

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

Example: 10.5
resultingCustomerBalancenumber[ 0.01 .. 9999999.99 ]read-only

customer balance after transaction has been applied in major currency (e.g pounds/dollars/euros)

Example: 10.5
currencyIdinteger(int64)read-onlyrequired

Currency Id

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

Payment description

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

Payment reference from third party payment system

typestring(PaymentMethod)required

Payment method

Enum"CHEQUE""DIRECT_DEBIT""CANCELLED_DD""CANCELLED_CARD""CREDIT_CARD""PAYPAL""BACS""POST_OFFICE_PAYMENT_CARD""EZYPAY""GO_CARDLESS"
paymentDatestring(date)read-only

When payment was made

customerPaymentTypestring(CustomerPaymentType)read-only

Type of payment

Enum"CUSTOMER""NORMAL_INVOICE""ADHOC_INVOICE""ADJUSTMENT""OUTBOUND_PAYMENT"
txnTypestring(TxnType)read-only

Type of transaction

Enum"INVOICE_CREATED""INVOICE_DISPUTED""INVOICE_WRITTEN_OFF""INVOICE_UNDISPUTED""INVOICE_UNWRITTEN_OFF""INVOICE_REFUNDED""INVOICE_CHARGED_BACK""INVOICE_PAYMENT""CUSTOMER_PAYMENT""BALANCE_ADJUSTMENT"
invoiceNumberstringread-only

Invoice Number

invoiceIdinteger(int64)read-only

Invoice identifier

Example: 0
billRunTypestring(BillRunType)

Bill run type

Enum"NORMAL""ADHOC"
inFlightbooleanread-only

is this customer payment 'in flight' meaning is it temporary and has yet to complete. These records are informational and should be replaced with success or failure records later

Default false
Response
application/json
{
  "id": 1,
  "customerId": 1,
  "amountInMajorCurrency": 10.5,
  "resultingCustomerBalance": 10.5,
  "currencyId": 1,
  "description": "string",
  "reference": "string",
  "type": "CHEQUE",
  "paymentDate": "2019-08-24",
  "customerPaymentType": "CUSTOMER",
  "txnType": "INVOICE_CREATED",
  "invoiceNumber": "string",
  "invoiceId": 0,
  "billRunType": "NORMAL",
  "inFlight": false
}

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