Reference
SDO
Optimize payment collection dates using Strike Date Optimization algorithms. Analyze historical transaction data to determine the best days for processing recurring payments and maximize collection success rates.
Request
Request to get the best date for collections
Path
POST /sdo
Request Body
{
"records": [{
"customer": {
"reference": "CLN240919000001",
"id_type_lookups_id": "loo_abc123...",
"id_number": "900112....",
},
}]
}
Request Parameters
Field | Required | Type | Description | Example |
|---|---|---|---|---|
| *.customer.reference | Y | String(35) | Reference to identify a specific customer | CLN240919000001 |
| *.customer.id_type_lookups_id | Y | String(32) | Required field for individuals. Lookups ID relating to the type of ID number e.g. South African ID, passport or temporary residence. | loo_abc123... |
| *.customer.id_number | Y | String(13) | Required field for individuals | 900112... |
Response Body
{
"status": true,
"results": [{
"days": {
"28": "8",
"30": "88",
"1": "4",
},
"customer": {
"reference": "CLN240919000001",
"id_type_lookups_id": "loo_abc123...",
"id_number": "900112....",
},
"warning": null,
"error": null
}, ...]
}
Response Parameters
Field | Type | Description | Example |
|---|---|---|---|
| *.days | Object | Object containing optimal collection days with their corresponding success probability percentages | {"28": "8", "30": "88", "1": "4"} |
| *.customer.reference | String(35) | Reference to identify a specific customer | CLN240919000001 |
| *.customer.id_type_lookups_id | String(32) | Required field for individuals. Lookups ID relating to the type of ID number e.g. South African ID, passport or temporary residence. | loo_abc123... |
| *.customer.id_number | String(13) | Required field for individuals | 900112... |
| *.warning | String | Any warning messages associated with this verification | null |
| *.error | String | Any error messages that occurred during verification | null |