API Requests & URLs

This page, and it's links, gives details on how to use SmarterPay Cloud API.

If you have issues with SmarterPay Cloud API please contact support, either by telephone on +44 (0)1482 240886, or by email at support@smarterpay.com

The following REST urls are available to connect to within the SmarterPay Cloud API. Your instance url will be supplied to you by your SmarterPay representative.
All requests and responses are JSON-formatted and UTF-8 encoded. Providing the Accept header is optional, but recommended.The Content-Type header must be provided when sending data to the API (using POST and PUT endpoints) passing either the standard JSON MIME type (application/json), or the JSON-API variant (application/vnd.api+json).
SmarterPay Cloud API is only available over HTTPS, attempting to access the API over an unsecured HTTP connection will return a TLS_Required error.

Rest Service Rest Service URL
Bank Account {Instance_url}/BankAccount
Client Bank Account {Instance_url}/Clientbankaccount
Credit {Instance_url}/Credit
Customer Account {Instance_url}/CustomerAccount
Mandate {Instance_url}/Mandate
Modulus Check {Instance_url}/ModulusCheck
Payment {Instance_url}/Payment
Payment Re-present {Instance_url}/Payment/{id}/Represent
Recurrence Schedule {Instance_url}/RecurrenceSchedule
Service User Number {Instance_url}/ServiceUserNumber

{Instance_url} Denotes the Base URL link for API.
{id} denotes ID of record.

Each API request will result in a response code and response text. You may encounter the following response codes. Any unsuccessful response codes will contain more information to help you identify the cause of the problem

200 OK should be the standard response for a successful API request. Other error codes may require further investigation.

Code Message Description
200OKStandard response for successful HTTP requests.
204No ContentThe server successfully processed the request, and is not returning any content.
400Bad RequestThe server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing).
405Method Not AllowedA request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.
406Not AcceptableThe requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.
498Invalid TokenCode 498 indicates an expired or otherwise invalid token.
500Internal Server ErrorA generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

  • Last modified: 2021/03/16 16:52