Payment Re-Present
Returned Unpaid Payments can be re-presented if required. Bacs rules govern how and when these payments can be re-presented.
Re-present records are a single payment retry from a customer, taken against an existing Unpaid Payment record and therefore requires a reference to the original payment.
SmarterPay will notify you via a webhook whenever the state of a re-presented payment changes.
If SmarterPay Cloud receives a re-present Payment request with a collection_date set to a none banking date (weekend or national bank holiday), SmarterPay Cloud will record/store the Payment record with next available banking day, and return this date in the response.
For example, if a POST request tries to set the “collection_date” to Friday 30th March, this is the Easter Bank Holiday weekend with both Friday 30th and Monday 2nd being national bank holidays, the date stored and returned is Tuesday 3rd April.
Method | Purpose |
---|---|
POST | Create a Payment Re-present |
PUT | Update a Payment - Refer to the Payment PUT section |
GET | Return Payment details - Refer to the Payment GET section |
POST
Action: Create a Payment Re-present.
Method: POST
URL: https://api.smarterpaycloud.com/service.svc/payment/{ID}/represent
{ID} denotes ID of Payment record.
Request Parameters
Property | Mandatory | Description |
---|---|---|
auddis | True | The unique AUDDIS ref beginning with the assigned prefix followed by an auto number. if no reference is provided to use then one will be generated. |
amount | True | Amount in pence – no decimal point |
description | True | Reference description – will be included in outgoing email |
collection_date | True | Date to receive payment - 10 digit date in the format of “YYYY-MM-DD” |
record_type | False | Default direct debit |
custom_reference | False | Custom reference set on record |
Request Sample
{ "payment": { "amount":100, "collection_date":"2018-08-25", "description":"metered bill", "auddis":"AUD00003435", "custom_reference":"XYZ" } }
Response Parameters
Property | Description |
---|---|
id | Unique identifier |
auddis | Unique auddis identifier |
amount | Amount |
description | Reference description – will be included in outgoing email |
collection_date | Date to receive payment - 10 digit date in the format of “YYYY-MM-DD”, corrected, if the date received by the service is a none banking day, weekend or national bank holiday |
created_at | Datetime formatted as ISO8601 |
status | This should always start with “pending_submission” and then change to “submitted”, can also be “failed”,“successful” or “cancelled” |
payment_type | Can be set to either “first_collection”, “ongoing_collection”,“final_collection” or “represent” |
related_payment | This is the Payment id of the initial Failed Payment, only applicable for represented payments |
record_type | Record type of payment, default will be “direct_debit” |
custom_reference | Custom reference set on record |
Response Sample
{ "payment": { "id":"PAY0000031", "created_at":"2018-08-23T12:43:18.000Z", "collection_date":"2018-08-25", "amount":100, "payment_type":"ongoing_collection", "description":"metered bill", "status":"pending_submission", "auddis":"AUD00003435", "related_payment":"PAY00000034", "record_type":"direct_debit", "custom_reference":"XYZ" } }