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
Path
Payment Method
Enum"CHEQUE""DIRECT_DEBIT""CANCELLED_DD""CANCELLED_CARD""CREDIT_CARD""PAYPAL""BACS""POST_OFFICE_PAYMENT_CARD""EZYPAY""GO_CARDLESS"
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
- https://rest.elevatebilling.com/v1/payment-provider-mandates/{paymentMethod}/{mandateReference}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://rest.elevatebilling.com/v1/payment-provider-mandates/{paymentMethod}/{mandateReference}?thirdPartyCustomerReference=string&contractOwnerId=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Payment provider mandate
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
Email address
Company name
Address line 1
Address line 2
Address line 3
Country code
Telephone number
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" }