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 |
| GET (List) | Return File Submission Line details in a list |
GET (Singular)
Action: Return File Submission Line details.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/submissionline/{ID}
{ID} denotes ID of record.
Response Parameters
| Property | Description |
|---|---|
| Id | Unique identifier for the record |
| amount | Amount, in pence, of the transaction |
| collection_date | Collection date of the transaction, in the format of “YYYY-MM-DD” |
| record_id | The ID of the transaction record |
| status | Status of the transaction |
| submission_id | ID of the submission record |
| transaction_code | Transaction code of the transaction |
| type | Type of the transaction |
Response Sample
{
"submissionLine": {
"Id": "FL01YZ96J1R0WRRJNEWD",
"amount": "0",
"collection_date": "2022-07-14",
"record_id": "M016DZMJN53EXEPK325",
"status": "Successful",
"submission_id": "FS01DNZWLJRDXQ8GQ914",
"transaction_code": "0N",
"type": "mandate"
}
}
GET (List)
Action: Return File Submission Line details in a list.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/submissionlines
Optional Parameters and filters are available, please see below.
Response Parameters
| Property | Description |
|---|---|
| Id | Unique identifier for the record |
| amount | Amount, in pence, of the transaction |
| collection_date | Collection date of the transaction, in the format of “YYYY-MM-DD” |
| record_id | The ID of the transaction record |
| status | Status of the transaction |
| submission_id | ID of the submission record |
| transaction_code | Transaction code of the transaction |
| type | Type of the transaction |
Response Sample
{
"submissionLines": [
{
"Id": "FL01YZ96J1R0WRRJNEWD",
"amount": "0",
"collection_date": "2022-07-14",
"record_id": "M016DZMJN53EXEPK325",
"status": "Successful",
"submission_id": "FS01DNZWLJRDXQ8GQ914",
"transaction_code": "0N",
"type": "mandate"
},
{
"Id": "FL01D1LRPM05904JYEQG",
"amount": "0",
"collection_date": "2022-07-14",
"record_id": "M01ZQ0583WG6MY86KNO",
"status": "Successful",
"submission_id": "FS01DNZWLJRDXQ8GQ914",
"transaction_code": "0N",
"type": "mandate"
}
]
}
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”,“type”,“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 “failed”, “successful”. |
| submission_id | Filter the list using the submission_id. Matches will exactly match the provided value. |
| transaction_code | Filter the list using the transaction_code of the record. Can be a comma seperated list of required values. Options are “0N”, “0C”, “0S”, “01”, “17”, “18”, “19”, “99”. |
| type | Filter the list using the type of the record. Can be a comma seperated list of required values. Options are “mandate”, “payment”, “credit”. |