Objects Browser

This section describes settings and configuration that can be made against the Salesforce package.
Other settings, such as 'DDMS' configuration (what happens on specific BACS error codes) are made in SmarterPay Cloud and as such are described in the SmarterPay Cloud WIKI (https://testwiki.smarterpay.com/smarterpaycloud/start/)



Account Validation

LABEL DESCRIPTION
ACCOUNT NAME MATCH If a validation has been performed, this will be the % match to the name. 100% is an exact match.
ACCOUNT NAME Account Name, returned by validation.
CLIENT ID ID of the connected Client record in SmarterPay Cloud.
LAST EVENT ID PROCESSED The SmarterPay Cloud Id of the very last event that was processed in Salesforce.
MANDATE ID ID of the connected Mandate record in SmarterPay Cloud.
MANDATE
MESSAGE Feedback from the validation process if there is an issue.
METADATA Additional data passed between SmarterPay Cloud and Salesforce. Can be used to populate additional fields.
REPORT RETURNED Has a validation report been received.
SMPC CREATED AT When the record was created in SmarterPay Cloud.
SMPC CREATED BY The ID of the SmarterPay Cloud user that created this record.
SMPC EDITED AT When the record was last edited in SmarterPay Cloud.
SMPC EDITED BY The ID of the SmarterPay Cloud user that last edited this record.
SMPC ID ID of the record in SmarterPay Cloud.
VALIDATION ACCOUNT NAME The Account Name of the customer, for validation.
VALIDATION ACCOUNT NUMBER Account Number, comprising of 8 numbers, for validation.
VALIDATION SORT CODE Sort Code, comprising of 6 numbers, for validation.
VALIDATION STATUS Has validation been performed.


API Queue

LABEL DESCRIPTION
ACCOUNT VALIDATION
BANK ACCOUNT
CARD
CREDIT
ERROR LOG
EVENT
MANDATE
PAYMENT
PREVIOUS RECORD JSON
RECORD ID
RECORD JSON A copy of the record at the time of the triggering event.
RECURRENCE SCHEDULE
RETRY COUNT
RETRY DATETIME
STATUS
TARGET SEQUENCE NUMBER
TYPE


Bank Account

LABEL DESCRIPTION
ACCOUNT CODE OK Is the Bank Account Number valid. Response from EISCD check.
ACCOUNT NAME Name of the account holder as known by the bank. This usually matches the name of the linked customer.
This field will be uppercased and truncated to 18 characters in SmarterPay Cloud.
ACCOUNT NUMBER The Account Number of the Bank Account. Must be 8 digits with no spaces or hyphens.
ACCOUNT
BACS DESCRIPTION Rejection Description supplied by BACS. Populated if there is a problem with the Bank Account.
BACS FILENAME File Name of the rejection report supplied by BACS. Populated if there is a problem with the Bank Account.
BACS REASON CODE The Rejection Reason Code supplied by BACS. Populated if there is a problem with the Bank Account.
BACS REFERENCE The Rejection Reference supplied by BACS. Populated if there is a problem with the Bank Account.
BANK NAME The name of the bank that the bank account resides. For example: BARCLAYS BANK PLC.
BANK TELEPHONE NUMBER The bank's phone number.
BRANCH ADDRESS 4 Fourth line of the bank branch that the bank account resides.
BRANCH ADDRESS 1 First line of the bank branch that the bank account resides.
BRANCH ADDRESS POSTCODE Postal Code of the bank branch that the bank account resides.
BRANCH ADDRESS 3 Third line of the bank branch that the bank account resides.
BRANCH ADDRESS TOWN The town of the bank branch that the bank account resides.
BRANCH ADDRESS 2 Second line of the bank branch that the bank account resides.
BRANCH TITLE The name or title of the branch where the bank account resides.
CLIENT ID ID of the connected Client record in SmarterPay Cloud.
CONTACT
CREDITS ALLOWED OK Can Credits be processed on this Bank Account. Response from EISCD check.
CURRENCY CODE
CUSTOM REFERENCE A custom reference or identifier of this record.
CUSTOMER ACCOUNT ID ID of the connected Customer Account record in SmarterPay Cloud.
DIRECT DEBIT INSTRUCTION OK Can Direct Debits be processed on this Bank Account. Response from EISCD check.
DIRECT DEBITS OK Can Direct Debits be processed on this Bank Account. Response from EISCD check.
ENABLED The current status of the Bank Account at SmarterPay Cloud.
LAST API QUEUE PROCESSED
LAST EVENT ID PROCESSED The SmarterPay Cloud Id of the very last event that was processed in Salesforce.
METADATA Additional data passed between SmarterPay Cloud and Salesforce. Can be used to populate additional fields.
SMPC CREATED AT When the record was created in SmarterPay Cloud.
SMPC CREATED BY The ID of the SmarterPay Cloud user that created this record.
SMPC EDITED AT When the record was last edited in SmarterPay Cloud.
SMPC EDITED BY The ID of the SmarterPay Cloud user that last edited this record.
SMPC ID ID of the record in SmarterPay Cloud.
SMPC LEGACY ID Older legacy ID of the record in SmarterPay Cloud. This will be empty for new records.
SORT CODE OK Does this Sort Code exist. Response from EISCD check.
SORT CODE The Sort Code of the Bank Account. Must be 6 digits with no spaces or hyphens.


Card

LABEL DESCRIPTION
ACCOUNT
ALLOW REPEAT PAYMENTS
CARD EXPIRY DATE After this date, the card becomes invalid for use.
CARD HOLDER ADDRESS CITY
CARD HOLDER ADDRESS COUNTRY CODE ISO 3166 Country Code
CARD HOLDER ADDRESS LINE 1
CARD HOLDER ADDRESS LINE 2
CARD HOLDER ADDRESS POSTAL CODE
CARD HOLDER ADDRESS STATE CODE 2-character state code. Typically, only used for United States payments.
CARD NUMBER ENDING The last four digits of the long card number.
CARD TYPE The name of the card issuer - for example Visa.
CLIENT ID ID of the connected Client record in SmarterPay Cloud.
CONTACT
CURRENCY CODE ISO 4217 representation of the currency that the transaction took place under.
CUSTOM REFERENCE A custom reference or identifier of this record.
CUSTOMER ACCOUNT ID ID of the connected Customer Account record in SmarterPay Cloud.
GATEWAY CARD ID Identifies the Card on the payment gateway. Normally set by the Payment Gateway.
GATEWAY PAYEE ID Identifies the Payee on the payment gateway. Normally set by the Payment Gateway.
GATEWAY PAYMENT DESCRIPTION An additional description that is sent to the Payment Gateway.
GATEWAY STATUS CODE The status code of the initial setup transaction as set by the Payment Gateway. See the Payment Gateway's documentation for details.
GATEWAY STATUS DETAILS Any additional details of the initial setup transaction as set by the Payment Gateway. See the Payment Gateway's documentation for details.
GATEWAY STATUS The status of the initial setup transaction as set by the Payment Gateway. See the Payment Gateway's documentation for details.
INITIAL AMOUNT The amount of the first transaction on the card.
INTERNAL PAYMENT DESCRIPTION An additional description that is not sent to the Payment Gateway.
LAST EVENT ID PROCESSED The SmarterPay Cloud Id of the very last event that was processed in Salesforce.
METADATA Additional data passed between SmarterPay Cloud and Salesforce. Can be used to populate additional fields.
NAME ON CARD The name of the cardholder as displayed on the card.
PAYMENT GATEWAY PROFILE ID ID of the connected Payment Gateway record in SmarterPay Cloud.
PAYMENT GATEWAY Friendly name of the connected Payment Gateway record in SmarterPay Cloud.
SMPC CREATED AT When the record was created in SmarterPay Cloud.
SMPC CREATED BY The ID of the SmarterPay Cloud user that created this record.
SMPC EDITED AT When the record was last edited in SmarterPay Cloud.
SMPC EDITED BY The ID of the SmarterPay Cloud user that last edited this record.
SMPC ID ID of the record in SmarterPay Cloud.
STATUS CODE SmarterPay's specific result code for this card.
STATUS DETAILS Any additional details of the result of the card set by SmarterPay.
STATUS The result or current state of the card.
TRANSACTION TYPE The type of transaction made and environment when setting up the card.


Credit

LABEL DESCRIPTION
AMOUNT The amount of money to be sent in the credit.
BACS DESCRIPTION Rejection Description supplied by BACS. Populated if there is a problem with the Credit.
BACS FILENAME File Name of the rejection report supplied by BACS. Populated if there is a problem with the Credit.
BACS REASON CODE The Rejection Reason Code supplied by BACS. Populated if there is a problem with the Credit.
BACS REFERENCE The Rejection Reference supplied by BACS. Populated if there is a problem with the Credit.
BANK ACCOUNT ID ID of the connected Bank Account record in SmarterPay Cloud.
BANK ACCOUNT
CLIENT ID ID of the connected Client record in SmarterPay Cloud.
CREDIT DATE Date credit received by recipient.
CUSTOM REFERENCE A custom reference or identifier of this record.
CUSTOMER ACCOUNT ID ID of the connected Customer Account record in SmarterPay Cloud.
DEFAULT NARRATIVE Text, associated with the transaction, which will be displayed in the customers Bank Account.
DESCRIPTION An additional description of the credit.
LAST API QUEUE PROCESSED
LAST EVENT ID PROCESSED The SmarterPay Cloud Id of the very last event that was processed in Salesforce.
MANDATE ID ID of the connected Mandate record in SmarterPay Cloud.
MANDATE
METADATA Additional data passed between SmarterPay Cloud and Salesforce. Can be used to populate additional fields.
ORIGINATING BANK ACCOUNT ID ID of the connected Originating Bank Account record in SmarterPay Cloud.
OVERRIDING NAME
RTI Used for Payroll Credits.
SMPC CREATED AT When the record was created in SmarterPay Cloud.
SMPC CREATED BY The ID of the SmarterPay Cloud user that created this record.
SMPC EDITED AT When the record was last edited in SmarterPay Cloud.
SMPC EDITED BY The ID of the SmarterPay Cloud user that last edited this record.
SMPC ID ID of the record in SmarterPay Cloud.
SMPC LEGACY ID Older legacy ID of the record in SmarterPay Cloud. This will be empty for new records.
SERVICE USER NUMBER ID ID of the connected Service User Number record in SmarterPay Cloud.
SERVICE USER NUMBER NAME Friendly name for the service user number.
SERVICE USER NUMBER The SUN that this Credit is registered under.
STATUS The result or current state of the credit.
SUBMISSION REFERENCE The Credit reference that will be sent to bacs.


Mandate

LABEL DESCRIPTION
ACCOUNT VALIDATION ID ID of the connected Account Validation record in SmarterPay Cloud.
ACCOUNT VALIDATION URL The URL that a customer should follow to complete Account Validation. This will request the customer to login to their bank account and confirm their details.
ACCOUNT VALIDATION Used on the initial insert of a Mandate. Tells SmarterPay Cloud that Account Validation should be completed first before setting up with BACS.
ACCOUNT
BACS DESCRIPTION Rejection Description supplied by BACS. Populated if there is a problem with the Mandate.
BACS FILENAME File Name of the rejection report supplied by BACS. Populated if there is a problem with the Mandate.
BACS REASON CODE The Rejection Reason Code supplied by BACS. Populated if there is a problem with the Mandate.
BACS REFERENCE The Rejection Reference supplied by BACS. Populated if there is a problem with the Mandate.
BANK ACCOUNT ID ID of the connected Bank Account record in SmarterPay Cloud.
BANK ACCOUNT
CLIENT ID ID of the connected Client record in SmarterPay Cloud.
CONTACT
CURRENCY CODE
CUSTOMER ACCOUNT ID ID of the connected Customer Account record in SmarterPay Cloud.
LAST API QUEUE PROCESSED
LAST EVENT ID PROCESSED The SmarterPay Cloud Id of the very last event that was processed in Salesforce.
METADATA Additional data passed between SmarterPay Cloud and Salesforce. Can be used to populate additional fields.
MULTIPLE SIGNATURES REQUIRED Some bank accounts have joint signatories and require both signatures to setup a new Direct Debit Mandate with BACS.
ORIGINATING BANK ACCOUNT ID ID of the connected Originating Bank Account record in SmarterPay Cloud.
REFERENCE The Mandate reference, commonly known as AUDDIS. If no reference is provided then one will be auto-generated by SmarterPay Cloud.
The Reference can not be changed once the Mandate has been created.
SMPC CREATED AT When the record was created in SmarterPay Cloud.
SMPC CREATED BY The ID of the SmarterPay Cloud user that created this record.
SMPC EDITED AT When the record was last edited in SmarterPay Cloud.
SMPC EDITED BY The ID of the SmarterPay Cloud user that last edited this record.
SMPC ID ID of the record in SmarterPay Cloud.
SMPC LEGACY ID Older legacy ID of the record in SmarterPay Cloud. This will be empty for new records.
SERVICE USER NUMBER ID ID of the connected Service User Number record in SmarterPay Cloud.
SERVICE USER NUMBER NAME Friendly name for the service user number.
SERVICE USER NUMBER The SUN that this Mandate is registered under.
STATUS The current status of the Mandate.


Payment

LABEL DESCRIPTION
AMOUNT The amount of the transaction.
AUTHORISATION CODE The authorisation code returned from your merchant bank about the transaction. Normally set by the Payment Gateway.
BACS DESCRIPTION Rejection Description supplied by BACS. Populated if there is a problem with the Payment.
BACS FILENAME File Name of the rejection report supplied by BACS. Populated if there is a problem with the Payment.
BACS REASON CODE The Rejection Reason Code supplied by BACS. Populated if there is a problem with the Payment.
BACS REFERENCE The Rejection Reference supplied by BACS. Populated if there is a problem with the Payment.
CARD ID ID of the connected Card record in SmarterPay Cloud.
CARD
CHARGE ID Identifies the transaction on the payment gateway. Normally set by the Payment Gateway.
CLIENT ID ID of the connected Client record in SmarterPay Cloud.
COLLECTION DATE Date to receive payment.
CURRENCY CODE ISO 4217 representation of the currency that the transaction took place under.
CUSTOM REFERENCE A custom reference or identifier of this record.
CUSTOMER ACCOUNT ID ID of the connected Customer Account record in SmarterPay Cloud.
DEFAULT NARRATIVE Text, associated with the transaction, which will be displayed in the customers Bank Account.
DESCRIPTION An additional description of the payment.
GATEWAY PAYMENT DESCRIPTION An additional description that is sent to the Payment Gateway.
GATEWAY STATUS CODE The status code of the transaction as set by the Payment Gateway. See the Payment Gateway's documentation for details.
GATEWAY STATUS DETAILS Any additional details of the transaction as set by the Payment Gateway. See the Payment Gateway's documentation for details.
GATEWAY STATUS The status of the transaction as set by the Payment Gateway. See the Payment Gateway's documentation for details.
INTERNAL PAYMENT DESCRIPTION An additional description that is not sent to the Payment Gateway.
LAST API QUEUE PROCESSED
LAST EVENT ID PROCESSED The SmarterPay Cloud Id of the very last event that was processed in Salesforce.
MANDATE ID ID of the connected Mandate record in SmarterPay Cloud.
MANDATE
METADATA Additional data passed between SmarterPay Cloud and Salesforce. Can be used to populate additional fields.
ORDER ID Identifies the transaction on the payment gateway. Normally set by the Payment Gateway.
ORIGINATING BANK ACCOUNT ID ID of the connected Originating Bank Account record in SmarterPay Cloud.
OVERRIDING NAME
PAYMENT TYPE
RECURRENCE SCHEDULE ID ID of the connected Recurrence Schedule record in SmarterPay Cloud.
RECURRENCE SCHEDULE
RELATED PAYMENT ID ID of the connected Related Payment record in SmarterPay Cloud.
RELATED PAYMENT
SMPC CREATED AT When the record was created in SmarterPay Cloud.
SMPC CREATED BY The ID of the SmarterPay Cloud user that created this record.
SMPC EDITED AT When the record was last edited in SmarterPay Cloud.
SMPC EDITED BY The ID of the SmarterPay Cloud user that last edited this record.
SMPC ID ID of the record in SmarterPay Cloud.
SERVICE USER NUMBER ID ID of the connected Service User Number record in SmarterPay Cloud.
SERVICE USER NUMBER NAME Friendly name for the service user number.
SERVICE USER NUMBER The SUN that this Payment is registered under.
STATUS CODE SmarterPay's specific result code for this transaction.
STATUS DETAILS Any additional details of the result of the transaction set by SmarterPay.
STATUS The result or current state of the payment.
TRANSACTION ID Identifies the transaction on the payment gateway. Normally set by the Payment Gateway.


Recurrence Schedule

LABEL DESCRIPTION
AMOUNT The amount per collection for Ongoing Payment, or the total Payment Plan amount that is divided over each instalment.
BACS DESCRIPTION Rejection Description supplied by BACS. Populated if there is a problem with the Recurrence Schedule.
BACS FILENAME File Name of the rejection report supplied by BACS. Populated if there is a problem with the Recurrence Schedule.
BACS REASON CODE The Rejection Reason Code supplied by BACS. Populated if there is a problem with the Recurrence Schedule.
BACS REFERENCE The Rejection Reference supplied by BACS. Populated if there is a problem with the Recurrence Schedule.
BANK ACCOUNT ID ID of the connected Bank Account record in SmarterPay Cloud.
CARD ID ID of the connected Card record in SmarterPay Cloud.
CARD
CLIENT ID ID of the connected Client record in SmarterPay Cloud.
COLLECTION DAY The day of the month that the collection will occur on.
COLLECTION PERIOD How SmarterPay will calculate the time between collections - whether to count by weeks or months.
COLLECTION STRETCH How many 'periods' between each collection. For example, selecting 2 here for 'monthly' would make a schedule to be collected every 2 months.
CUSTOM REFERENCE A custom reference or identifier of this record.
CUSTOMER ACCOUNT ID ID of the connected Customer Account record in SmarterPay Cloud.
DESCRIPTION An additional description of the payment.
END DATE SmarterPay will not calculate collections beyond this date.
FIRST COLL IN SAME MONTH AS NEXT COLL When set to true this will allow the first two collections in the same month. This can happen when the first collection date is less than the collection day.
FIRST COLLECTION AMOUNT The amount to take on the very first collection. Can differ than the normal scheduled amount. Used for Ongoing Payments.
FIRST COLLECTION DATE The very first date to receive payment. If left blank, Start Date will be used as the first payment date.
INSTALLMENTS How many collections should be scheduled on the Payment Plan.
LAST API QUEUE PROCESSED
LAST EVENT ID PROCESSED The SmarterPay Cloud Id of the very last event that was processed in Salesforce.
MANDATE ID ID of the connected Mandate record in SmarterPay Cloud.
MANDATE
METADATA Additional data passed between SmarterPay Cloud and Salesforce. Can be used to populate additional fields.
NEXT COLLECTION DATE The next date to receive payment.
RECURRENCE TYPE The type of schedule that should be set up. Whether it's a regular ongoing payment, or a fixed term plan of payments.
SMPC CREATED AT When the record was created in SmarterPay Cloud.
SMPC CREATED BY The ID of the SmarterPay Cloud user that created this record.
SMPC EDITED AT When the record was last edited in SmarterPay Cloud.
SMPC EDITED BY The ID of the SmarterPay Cloud user that last edited this record.
SMPC ID ID of the record in SmarterPay Cloud.
SMPC LEGACY ID Older legacy ID of the record in SmarterPay Cloud. This will be empty for new records.
START DATE The very first date to receive payment. This should be set to the date that the first collection is expected on. Non-banking days will be calculated by SmarterPay.
STATUS Details whether or not the Recurrence Schedule is currently used.
TOTAL VALUE The total amount that the Payment Plan is setup for.
UPCOMING PAYMENTS The current schedule calculated by SmarterPay Cloud in JSON format. Ongoing Collections will have up to 6 schedules calculated in advance.
You can manually adjust upcoming payments by updating the JSON.


Submission

LABEL DESCRIPTION
CLIENT ID ID of the connected Client record in SmarterPay Cloud.
CREDIT FAILED COUNT Number of failed Credits in the Submission.
CREDIT FAILED VALUE Value of failed Credits in the Submission.
CREDIT TOTAL COUNT Number of Credits in the Submission.
CREDIT TOTAL VALUE Value of Credits in the Submission.
LAST EVENT ID PROCESSED The SmarterPay Cloud Id of the very last event that was processed in Salesforce.
MANDATE CANCELLATION COUNT Number of Cancelled Mandates (0C) in the Submission.
MANDATE CONVERT COUNT Number of Converted Mandates (0S) in the Submission.
MANDATE FAILED COUNT Number of failed Mandates in the Submission.
MANDATE NEW INSTRUCTION COUNT Number of New Mandates (0N) in the Submission.
PAYMENT FAILED COUNT Number of failed Payments in the Submission.
PAYMENT FAILED VALUE Value of failed Payments in the Submission.
PAYMENT TOTAL COUNT Number of Payments in the Submission.
PAYMENT TOTAL VALUE Value of Payments in the Submission.
SMPC CREATED AT When the record was created in SmarterPay Cloud.
SMPC CREATED BY The ID of the SmarterPay Cloud user that created this record.
SMPC EDITED AT When the record was last edited in SmarterPay Cloud.
SMPC EDITED BY The ID of the SmarterPay Cloud user that last edited this record.
SMPC ID ID of the record in SmarterPay Cloud.
SERIAL The Serial Number of the Submission.
SERVICE USER NUMBER ID ID of the connected Service User Number record in SmarterPay Cloud.
SERVICE USER NUMBER NAME Friendly name for the service user number.
SERVICE USER NUMBER The SUN that this Submission is registered under.
STATUS The result or current state of the submission.


Webhook Event

LABEL DESCRIPTION
ACCOUNT VALIDATION
ACCOUNT
BANK ACCOUNT
CARD
CONTACT
CREDIT
ERROR LOG
EVENT DATETIME
EVENT ID
EVENT JSON
EVENT SOURCE The source of the event on SmarterPay Cloud. For example API.
EVENT TYPE The cause of the event in SmarterPay Cloud. For example: card_payment.create
MANDATE
MISC RECORD ID Used for customer account if it is related to an uncommon object.
PAYMENT
RECORD TYPE Some SmarterPay Cloud records have an additional record type to distinguish between subtypes of a table.
For example, 'payment' includes direct debit and card payments.
RECURRENCE SCHEDULE
RETRY COUNT
RETRY DATETIME
SMPC ID The SmarterPay Cloud Id of the record that the event has been triggered by.
STATUS The status of the event being processed into the system.
SUBMISSION
WEBHOOK QUEUE


Webhook Queue

LABEL DESCRIPTION
CLIENT ID
FAILED EVENTS
IDEMPOTENCY KEY
SENT AT
UNPROCESSED EVENTS Number of outstanding events to process
WEBHOOK ID
WEBHOOK VERSION