Skip to content
/
Create a new invoice paym...

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

Get a list of available invoice payment events

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
billRunIdstring(StringFilterParam)

Filter by bill run id

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

Filter by customer payment type

Example: customerPaymentType=xyz | in:x,y | like:xyz
customerPaymentIdstring(IdFilterParam)

Customer payment id

Example: customerPaymentId=0
generatedInvoiceIdstring(IdFilterParam)

Invoice id

Example: generatedInvoiceId=0
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/invoice-payments?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&billRunId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&customerPaymentType=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&customerPaymentId=0&generatedInvoiceId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Invoice Payment identifier

Example: 1
generatedInvoiceIdinteger(int64)required

Generated Invoice identifier

Example: 1
thirdPartyPaymentStatusstring(ThirdPartyPaymentStatus)

Invoice payment status. Not applicable for manual payments

Enum"NEW""CREATED""PENDING_CUSTOMER_APPROVAL""PENDING_SUBMISSION""SUBMITTED""CONFIRMED""PAID_OUT""CANCELLED""FAILED""FAILED_RETRYING"
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%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Payment description

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

Meta data

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

Error information from payment provider

paymentMethodstring(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"
customerPaymentIdinteger(int64)read-only

Customer payment id

Example: 1
]
Response
application/json
[
  {
    "id": 1,
    "generatedInvoiceId": 1,
    "thirdPartyPaymentStatus": "NEW",
    "amountInMajorCurrency": 10.5,
    "currencyId": 1,
    "description": "string",
    "metaData": "string",
    "errorInfo": "string",
    "paymentMethod": "CHEQUE",
    "paymentDate": "2019-08-24",
    "customerPaymentType": "CUSTOMER",
    "customerPaymentId": 1
  }
]

Create a new invoice payment

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New invoice payment

generatedInvoiceIdinteger(int64)required

Generated Invoice identifier

Example: 1
thirdPartyPaymentStatusstring(ThirdPartyPaymentStatus)

Invoice payment status. Not applicable for manual payments

Enum"NEW""CREATED""PENDING_CUSTOMER_APPROVAL""PENDING_SUBMISSION""SUBMITTED""CONFIRMED""PAID_OUT""CANCELLED""FAILED""FAILED_RETRYING"
amountInMajorCurrencynumber[ -100000 .. 100000 ]required

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

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

Payment description

paymentMethodstring(PaymentMethod)required

Payment method

Enum"CHEQUE""DIRECT_DEBIT""CANCELLED_DD""CANCELLED_CARD""CREDIT_CARD""PAYPAL""BACS""POST_OFFICE_PAYMENT_CARD""EZYPAY""GO_CARDLESS"
curl -i -X POST \
  https://rest.elevatebilling.com/v1/invoice-payments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "generatedInvoiceId": 1,
    "thirdPartyPaymentStatus": "NEW",
    "amountInMajorCurrency": 10.5,
    "description": "string",
    "paymentMethod": "CHEQUE"
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Invoice Payment identifier

Example: 1
generatedInvoiceIdinteger(int64)required

Generated Invoice identifier

Example: 1
thirdPartyPaymentStatusstring(ThirdPartyPaymentStatus)

Invoice payment status. Not applicable for manual payments

Enum"NEW""CREATED""PENDING_CUSTOMER_APPROVAL""PENDING_SUBMISSION""SUBMITTED""CONFIRMED""PAID_OUT""CANCELLED""FAILED""FAILED_RETRYING"
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%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Payment description

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

Meta data

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

Error information from payment provider

paymentMethodstring(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"
customerPaymentIdinteger(int64)read-only

Customer payment id

Example: 1
Response
application/json
{
  "id": 1,
  "generatedInvoiceId": 1,
  "thirdPartyPaymentStatus": "NEW",
  "amountInMajorCurrency": 10.5,
  "currencyId": 1,
  "description": "string",
  "metaData": "string",
  "errorInfo": "string",
  "paymentMethod": "CHEQUE",
  "paymentDate": "2019-08-24",
  "customerPaymentType": "CUSTOMER",
  "customerPaymentId": 1
}

Get a specific invoice payment event

Request

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

Invoice payment identifier

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

Responses

Invoice payment found

Bodyapplication/json
idinteger(int64)read-only

Invoice Payment identifier

Example: 1
generatedInvoiceIdinteger(int64)required

Generated Invoice identifier

Example: 1
thirdPartyPaymentStatusstring(ThirdPartyPaymentStatus)

Invoice payment status. Not applicable for manual payments

Enum"NEW""CREATED""PENDING_CUSTOMER_APPROVAL""PENDING_SUBMISSION""SUBMITTED""CONFIRMED""PAID_OUT""CANCELLED""FAILED""FAILED_RETRYING"
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%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Payment description

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

Meta data

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

Error information from payment provider

paymentMethodstring(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"
customerPaymentIdinteger(int64)read-only

Customer payment id

Example: 1
Response
application/json
{
  "id": 1,
  "generatedInvoiceId": 1,
  "thirdPartyPaymentStatus": "NEW",
  "amountInMajorCurrency": 10.5,
  "currencyId": 1,
  "description": "string",
  "metaData": "string",
  "errorInfo": "string",
  "paymentMethod": "CHEQUE",
  "paymentDate": "2019-08-24",
  "customerPaymentType": "CUSTOMER",
  "customerPaymentId": 1
}

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

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