A representation of a system that Elevate will interoperate with to collect payments, e.g. Go Cardless or Finastra
Elevate Payment and Refund API (1.37)
- 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
Languages
Servers
https://rest.elevatebilling.com/v1
Bodyapplication/jsonrequired
New payment provider payment link
Amount in major currency (e.g pounds/dollars/euros)
Example: 10.5
- https://rest.elevatebilling.com/v1/payment-provider-payment-link
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://rest.elevatebilling.com/v1/payment-provider-payment-link \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"paymentProviderId": 1,
"amountInMajorCurrency": 10.5,
"description": "string",
"emailAddress": "string",
"invoiceId": 1,
"adhocInvoiceId": 1,
"customerId": 1
}'Response
application/json
{ "id": 1, "paymentProviderId": 1, "amountInMajorCurrency": 10.5, "currencyId": 1, "description": "string", "emailAddress": "string", "invoiceId": 1, "adhocInvoiceId": 1, "customerId": 1, "paymentLink": "https://instantpaymentlink/exampleref" }