Responses
Common Responses for the object.
Get
Get Response Parameters
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. |
Get Response Sample - Single
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 Response Sample - Multiple
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"
}
]
}