File 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 |
GET (Singular)
Action: Return File Submission details.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/submission/{ID}
{ID} denotes ID of record.
Response Parameters
| Property | Description |
|---|---|
| Id | Unique identifier for the record. |
| created_at | Datetime formatted as ISO8601. |
| credit_total_count | Count of the Credits in the Submission. |
| credit_total_value | Value of the Credits, in pence, in the Submission. |
| mandate_cancellation_count | Count of the Cancelled Mandates (OC) in the Submission. |
| mandate_convert_count | Count of the Converted Mandates (0S) in the Submission. |
| mandate_new_instruction_count | Count of the New Mandates (0N) in the Submission. |
| payment_total_count | Count of the Payments in the Submission. |
| payment_total_value | Value of the Payments, in pence, in the Submission. |
| serial_number | Serial number of the File Submission. |
| status | Status of the File Submission. Can be: “Submitted” or “Submitted With errors”. |
| Sun_name | Friendly name attached to the sun. |
| Sun_Number | Sun that is attached to this submission. |
Response Sample
{
"submission": {
"Id": "FS01DNZWLJRDXQ8GQ914",
"created_at": "2022-07-14T13:57:54Z",
"credit_total_count": "2",
"credit_total_value": "2000",
"mandate_cancellation_count": "2",
"mandate_convert_count": "0",
"mandate_new_instruction_count": "2",
"payment_total_count": "24",
"payment_total_value": "69000",
"serial_number": "J1ORWJ",
"status": "Submitted",
"sun_name": "Smarterpay Test",
"sun_number": "100263"
}
}
GET (List)
Action: Return File Submission details in a list.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/submissions
Optional Parameters and filters are available, please see below.
Response Parameters
| Property | Description |
|---|---|
| Id | Unique identifier for the record. |
| created_at | Datetime formatted as ISO8601. |
| credit_total_count | Count of the Credits in the Submission. |
| credit_total_value | Value of the Credits, in pence, in the Submission. |
| mandate_cancellation_count | Count of the Cancelled Mandates (OC) in the Submission. |
| mandate_convert_count | Count of the Converted Mandates (0S) in the Submission. |
| mandate_new_instruction_count | Count of the New Mandates (0N) in the Submission. |
| payment_total_count | Count of the Payments in the Submission. |
| payment_total_value | Value of the Payments, in pence, in the Submission. |
| serial_number | Serial number of the File Submission. |
| status | Status of the File Submission. Can be: “Submitted” or “Submitted With errors”. |
| Sun_name | Friendly name attached to the sun. |
| Sun_Number | Sun that is attached to this submission. |
Response Sample
{
"submissions": [
{
"Id": "FS01MQ0KN8XRR68OXZG7",
"created_at": "2022-07-12T09:41:14Z",
"credit_total_count": "0",
"credit_total_value": "0",
"mandate_cancellation_count": "0",
"mandate_convert_count": "0",
"mandate_new_instruction_count": "0",
"payment_total_count": "10",
"payment_total_value": "550",
"serial_number": "JZG1MP",
"status": "Submitted With Errors",
"sun_name": "Smarterpay Test",
"sun_number": "100263"
},
{
"Id": "FS01XYR6K8K99G84ZLQV",
"created_at": "2022-07-12T10:55:31Z",
"credit_total_count": "0",
"credit_total_value": "0",
"mandate_cancellation_count": "0",
"mandate_convert_count": "0",
"mandate_new_instruction_count": "1",
"payment_total_count": "0",
"payment_total_value": "0",
"serial_number": "P4EZX8",
"status": "Submitted",
"sun_name": "Smarterpay Test",
"sun_number": "100263"
}
]
}
Optional Parameters and filters
Optional parameters can be added to the GET URL by using a “?” in front of the first parameter and “&” in front of subsequent parameters, for example https://api.smarterpaycloud.com/Service.svc/BankAccounts?limit=2&page_no=1
| Parameter | Description |
|---|---|
| limit | Limits the number of records returned by the request. Default=40 when not specified. Minimum=1. Maximum=500. |
| page_no | Specifies which page of records are returned by the request. Default=1 when not specified. |
| sort_field | specifies which field to sort on. Options are: “id”,“sun”,“created_at” (Default when not specified). |
| sort_order | Specifies which order to sort on. Options are asc (ascending. Default when not specified) or desc (descending). |
| Filter | Description |
|---|---|
| created_from | Filter the list with records created after the datetime supplied. Format is YYYY-MM-DD HH:MM:SS (2022-05-13 10:15:00). |
| created_to | Filter the list with records created before the datetime supplied. Format is YYYY-MM-DD HH:MM:SS (2022-05-13 10:15:00). |
| id | Filter the list using the id. Matches will exactly match the provided value. |
| status | Filter the list using the status of the record. Can be a comma seperated list of required values. Options are “submitted”, “submitted with errors”. |
| sun | Filter the list using the Sun Number. Matches will exactly match the provided value. |