Responses
Common Responses for the object.
Get
Get Response Parameters
Response Parameters
| Property | Description |
|---|---|
| id | Unique identifier for the record. |
| url | Link URL. |
| amount | Link Amount, if set. |
| description | Description in the link, if set. |
| bank_account_custom_reference | Bank account customer reference, if set. |
| recurrence_schedule_custom_reference | Schedule custom reference, if set. |
| card_payment_custom_reference | Card Payment Custom reference, if set. |
| auddis | Mandate AUDDIS reference, if set. |
| customer_account | Customer Account ID, if set. |
| bank_account | Bank Account ID, if set. |
| mandate | Mandate ID, if set. |
| recurrence_schedule | Schedule ID, if set. |
| ecommerce_page | Ecommerce Page ID. |
| status | Link status. Can be “active”, “expired”. |
| expiry | Link expiry date, if set. |
| return_url | Link return URL, if set. |
| visited_at | Link visited at date, if set. |
| completed_at | Link completed at, if set. |
| created_at | Link creation date. |
| account_validation_callback | Link requires Account Validation. Can be “true”, “false”. |
| start_date | Schedule start date, if set. |
| end_date | Schedule end date, if set. |
| first_collection_amount | Schedule first collection amount, if set. |
| first_collection_date | Schedule first collection date, if set. |
Get Response Sample - Single
Response Sample
{
"payment_link": {
"id": "PL01GOVWD48GD28N0M76",
"url": "https://smarterpay-test-ecommerce.azurewebsites.net?setup=MJS44ChfVVOPuN68nbOvp9bsZrYtO6n1IAX9yKJAI4HtNxTPqJmj2PM%2BlSvd1Nv4vURbLe9s7EFtv5L0egYxV10Kuja5TM5xTtVnjKh5qGbNvJ2Ty%2BzIZp%2FnpHSgysP9&payment=KkaGURMTwUIAFcDQhNgVZv32B3%2Bn0uRPnvnvPLvffr8Q6ZVlBdsc1yjHFqyBxZd%2Fw7WQywzhG4B%2Bkvh%2FSYdWpWUC75uxF0IeaqK3cc6ZprUkM9pg2znX00jhejBBnrWx&page=455030324B4F354430473830584D504552573456",
"amount": "2750",
"description": "Payment Plan",
"bank_account_custom_reference": null,
"recurrence_schedule_custom_reference": null,
"card_payment_custom_reference": null,
"auddis": null,
"customer_account": "CA01OQW39P4GY7J56NXL",
"bank_account": null,
"mandate": null,
"recurrence_schedule": null,
"ecommerce_page": "EP02KO5D0G80XMPERW4V",
"status": "active",
"expiry": "never",
"return_url": null,
"visited_at": null,
"completed_at": null,
"created_at": "2023-07-13 11:12:45",
"account_validation_callback": false,
"start_date": null,
"end_date": null,
"first_collection_amount": null,
"first_collection_date": null
}
}
Get Response Sample - Multiple
Response Sample
{
"payment_links": [
{
"id": "PL01EXYR6K8K9Y84ZLQV",
"url": "https://smarterpay-test-ecommerce.azurewebsites.net?setup=MJS44ChfVVOPuN68nbOvp9bsZrYtO6n1IAX9yKJAI4HtNxTPqJmj2PM%2BlSvd1Nv4vURbLe9s7EFtv5L0egYxV10Kuja5TM5xTtVnjKh5qGbNvJ2Ty%2BzIZp%2FnpHSgysP9&payment=iZ5KexxAyj%2BcFdHVzrgwsQz59pnX%2FfIkAtYvXkA%2B7n0eccbnq5i3qmyZLqpVs2AJQ6wnK5JeuIhR3IQXt3Jhuznoprs7hsFGrkYUS%2BVkvjiLJJIzJbsOommmUSuveAnn&page=455030324B4F354430473830584D504552573456",
"amount": "2750",
"description": "Payment Plan",
"bank_account_custom_reference": null,
"recurrence_schedule_custom_reference": null,
"card_payment_custom_reference": null,
"auddis": null,
"customer_account": "CA016YQRDJZW9KJVL359",
"bank_account": "BA01VQY3LJO0NLPE61OG",
"mandate": null,
"recurrence_schedule": null,
"ecommerce_page": "EP02KO5D0G80XMPERW4V",
"status": "expired",
"expiry": "2023-07-12 12:48:37",
"return_url": null,
"visited_at": null,
"completed_at": null,
"created_at": "2023-07-12 12:18:37",
"account_validation_callback": false,
"start_date": null,
"end_date": null,
"first_collection_amount": null,
"first_collection_date": null
},
{
"id": "PL01GOVWD48GD28N0M76",
"url": "https://smarterpay-test-ecommerce.azurewebsites.net?setup=MJS44ChfVVOPuN68nbOvp9bsZrYtO6n1IAX9yKJAI4HtNxTPqJmj2PM%2BlSvd1Nv4vURbLe9s7EFtv5L0egYxV10Kuja5TM5xTtVnjKh5qGbNvJ2Ty%2BzIZp%2FnpHSgysP9&payment=KkaGURMTwUIAFcDQhNgVZv32B3%2Bn0uRPnvnvPLvffr8Q6ZVlBdsc1yjHFqyBxZd%2Fw7WQywzhG4B%2Bkvh%2FSYdWpWUC75uxF0IeaqK3cc6ZprUkM9pg2znX00jhejBBnrWx&page=455030324B4F354430473830584D504552573456",
"amount": "2750",
"description": "Payment Plan",
"bank_account_custom_reference": null,
"recurrence_schedule_custom_reference": null,
"card_payment_custom_reference": null,
"auddis": null,
"customer_account": "CA01OQW39P4GY7J56NXL",
"bank_account": null,
"mandate": null,
"recurrence_schedule": null,
"ecommerce_page": "EP02KO5D0G80XMPERW4V",
"status": "active",
"expiry": "never",
"return_url": null,
"visited_at": null,
"completed_at": null,
"created_at": "2023-07-13 11:12:45",
"account_validation_callback": false,
"start_date": null,
"end_date": null,
"first_collection_amount": null,
"first_collection_date": null
}
]
}