Responses
Common Responses for the object.
Get
Get Response Parameters
Response Parameters
| Property | Description |
|---|---|
| amount | Amount |
| auddis | Auddis reference |
| 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 |
| custom_reference | Custom reference set on record |
| default_narrative | Text, associated with the transaction, which will be displayed in the customer's bank account. Maximum 18 characters. |
| description | Reference description – will be included in outgoing email |
| id | Unique identifier |
| mandate | ID of the parent Mandate |
| payment_type | Can be: “first collection”, “ongoing collection”, “final collection”, “represent”, “ecommerce” or “MOTO” |
| record_type | Can be: “direct_debit” or “card_payment” |
| related_payment | This is the Payment id of the initial Failed Payment, only applicable for represented payments |
| status | Can be: “pending_submission” ,“submitted”, “failed”, “successful” or “cancelled” |
| metadata | Returns optional, custom, metadata, if set |
| users_reference | Returns optional, payment reference, if set |
Get Response Sample - Single
Response Sample
{
"payment": {
"amount": "2532",
"auddis": "FBMAN02814872",
"collection_date": "2022-05-19",
"created_at": "2022-05-17T12:15:00Z",
"custom_reference": "",
"default_narrative": "",
"description": "",
"id": "P01YZ96J1D7WDK8NEWD",
"mandate": "M01741EJ519Y51P3XGL",
"payment_type": "ongoing collection",
"record_type": "direct_debit",
"related_payment": " ",
"status": "successful",
"metadata": "",
"users_reference": ""
}
}
Get Response Sample - Multiple
Response Sample
{
"payments": [
{
"amount": "1000",
"auddis": "F05AR10M00000001",
"collection_date": "2022-05-17",
"created_at": "2022-05-12T11:27:35Z",
"custom_reference": "",
"default_narrative": "",
"description": "Created By File Upload",
"id": "P01RM9OPEGQR9W8024D",
"mandate": "M017ZGLJLWL43QPW53E",
"payment_type": "ongoing collection",
"record_type": "direct_debit",
"related_payment": " ",
"status": "successful",
"metadata": "",
"users_reference": ""
},
{
"amount": "1000",
"auddis": "F05AR10M00000002",
"collection_date": "2022-05-17",
"created_at": "2022-05-12T11:27:35Z",
"custom_reference": "",
"default_narrative": "",
"description": "Created By File Upload",
"id": "P01Q0KN8XRYN7Q8OXZG",
"mandate": "M013ZN7JWDQMN5PGEX5",
"payment_type": "ongoing collection",
"record_type": "direct_debit",
"related_payment": " ",
"status": "successful",
"metadata": "",
"users_reference": ""
}
]
}