https://wiki.smarterpay.com/ 2026-04-28T19:48:24+00:00 https://wiki.smarterpay.com/ https://wiki.smarterpay.com/_media/wiki/logo.png text/html 2024-11-11T09:03:08+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/accountvalidation?rev=1731315788&do=diff Account Validation Account Validation records hold the details of an Account Validation check. Method Purpose Create an Account Validation record Retrieve Account Validation details ---------- POST Action: text/html 2024-10-11T13:28:06+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/apirequest?rev=1728653286&do=diff API Request API Request records hold the details of a Bulk API request. Method Purpose Return API Request details ---------- GET (Singular) Action: Return API Request details. text/html 2026-03-26T14:10:57+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/bankaccount?rev=1774534257&do=diff Bank Account Bank Account records hold the bank details of a customer. These records may be linked to a customer account record and may also be linked to several Direct Debit Mandates. SmarterPay will notify you via a webhook whenever the state of a bank account record changes text/html 2023-03-16T15:47:28+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/card?rev=1678981648&do=diff Card Card records hold basic details of a customer credit/debit card. Method Purpose GET (List) Retrieve Card details in a list ---------- GET (List) Action: Retrieve Card details in a list. Method: GET text/html 2024-02-14T16:41:29+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/cardpayment?rev=1707928889&do=diff Card Payments This section is around the Card Payment API portion of the SmarterPay Cloud product. ---------- Further reading: cardpayment index ---------- Card Payment API Responses As our software interacts with many different Card Payment Gateways we normalise the different responses we receive from those APIs into one. This means you can easily switch between Payment Gateways without having to rewrite your own backend code. text/html 2023-03-16T15:47:14+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/clientbankaccount?rev=1678981634&do=diff Client Bank Account Client bank account records are where the client owners bank account records are stored. These are the bank account records that are lodged against a service user number or SUN. Method text/html 2025-08-26T13:41:11+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/credit?rev=1756215671&do=diff Credit Credit records represent a BACS Credit, this is not a refund against any one Direct Debit collection. Credits can be used for Bill payments, payroll or indeed to make a genuine refund. If SmarterPay Cloud receives a Credit message with credit_date set to a none banking date (weekend or national bank holiday), SmartyerPay Cloud will record/store the Payment record with next available banking day, and return this date in the response. For example the following POST request, sets the “cred… text/html 2025-09-18T14:34:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/customeraccount?rev=1758206045&do=diff Customer Account Customer Account records hold the contact details for a customer. A customer can have several customer bank accounts, which in turn can have several Direct Debit mandate setup, payments taken or refunds setup. {id} donates the id of the record. text/html 2023-07-06T09:55:22+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/ecommercebranding?rev=1688637322&do=diff Ecommerce Branding (V2) Ecommerce Branding records contain Company and Styling settings used for E-Commerce pages and Email subscriptions. API request for V2 records only. Method Purpose text/html 2023-07-06T16:02:42+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/ecommercepagesetup?rev=1688659362&do=diff Ecommerce Page Setup (V2) Ecommerce Page Setup records contain the configuration for how the Ecommerce links should behave, and which actions are available to the customer clicking on the link. API request for V2 records only. Method text/html 2025-01-07T11:43:06+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/mandate?rev=1736250186&do=diff Mandate Mandates represent the Direct Debit Instruction with a customer. SmarterPay will notify you via a webhook whenever the state of a Mandate changes. If a Mandate is cancelled any payments, or credits, currently set to “pending_submission” will be updated and set to “cancelled”, and update notifications will be sent via payment or credit Webhooks. For example, if the mandate AUD0012345678 is set to cancelled and two payments are still to be collected, the reply will detail the Cancelled M… text/html 2024-10-01T11:29:02+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/moduluscheck?rev=1727782142&do=diff Modulus Check This service allows to check the validity of a account number and sortcode, returning various details about the account Method Purpose POST Modulus Check Account Details ---------- POST text/html 2023-03-16T15:38:24+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/outboundmessage?rev=1678981104&do=diff Outbound Message Outbound Message records hold the details of Emails or Webhooks sent out from the system. Method Purpose Return Outbound Message details Return Outbound Message details in a list Resend Outbound Message text/html 2025-05-13T14:15:08+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/payment?rev=1747145708&do=diff Payment Payments can only be setup against active Mandate, the dd_status values must be “new_instructions”, “first_collection”, “ongoing_collection” or “final_collection”, if the dd_status is set to “cancelled”, “cancelled by payer text/html 2024-11-22T11:12:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/paymentlink?rev=1732273960&do=diff Payment Link Payment Link records contain link information, generated for the Ecommerce pages. Method Purpose POST Create a Payment Link PUT text/html 2026-02-04T12:15:53+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/paymentrepresent?rev=1770207353&do=diff Payment Re-Present Returned Unpaid Payments can be re-presented if required. Bacs rules govern how and when these payments can be re-presented. Re-present records are a single payment retry from a customer, taken against an existing Unpaid Payment record and therefore requires a reference to the original payment. text/html 2025-10-08T14:55:37+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/recurrenceschedule?rev=1759935337&do=diff Recurrence Schedule Recurrence Schedules are used to automatically take payments on a regular basis, according to a defined schedule. For Direct Debits, a Payment must happen at least every 12 months, if not the Direct debit is cancelled at 13 months by the paying bank. text/html 2023-03-16T15:39:42+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/serviceusernumber?rev=1678981182&do=diff Service User Number A Service User Number(SUN) is a unique identifier for organisations collecting payment by Direct Debit. All communications with Bacs require a SUN. Method text/html 2024-08-02T13:29:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/submission?rev=1722605353&do=diff Submission File Submission records hold the details of files sent off for Submission. Method Purpose GET (Singular) Return File Submission details GET (List) Return File Submission details in a list text/html 2024-08-02T13:29:43+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.smarterpay.com/smarterpaycloud/api/restcommands/submissionline?rev=1722605383&do=diff Submission Line File Submission Line records hold the details of Credits, Mandates and Payments that have been sent off as part of a Submission. Method Purpose GET (Singular) Return File Submission Line details