Dunning Event
Dunning event request from SQS to process the dunning event
URL
https://[localhost]:[port]/dunning-application/v1/event
Param
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
| name | type | description | required |
|---|
| | |
cURL Request
{
"apf2doc": {
"request": {
"sender": "A",
"id": "1234567"
},
"acct_data": {
"client_acct_id": "21516069-21514548",
"acct_no": 36669641
},
"acct_contact": {
"first_name": "Medium Risk",
"phone": "17876041971",
"email": "lanka.jyotshna-sri@capgemini.com"
},
"notify_tmplt_group_data": {
"notify_tmplt_group": {
"notify_tmplt_group_id": "LLA_PR_SPANISH_NTG"
}
},
"master_plan_instance_data": {
"master_plan_instance": {
"client_master_plan_instance_id": "ACCOUNT_MASTER_144314124278",
"dunning_state": "1",
"dunning_step_description": "Due Date Notice|PRE|PRE|PRE|PRE|S",
"supp_plan_instance_data": {
"spi_supp_fields_data": {
"spi_supp_field": {
"field_name": "MSISDN",
"field_value": "10987678906"
}
}
}
}
},
"event_data": {
"event": {
"event_id": "744"
}
}
}
}
Definitions
| name | type | description | required |
|---|
| apf2doc | object | | N |
| apf2doc.request | object | | N |
| apf2doc.request.sender | string | sender name | Y |
| apf2doc.request.id | string | sender unique identifier | Y |
| apf2doc.acct_data | object | | N |
| apf2doc.acct_data.client_acct_id | string | event billing account number - customer account number | Y |
| apf2doc.acct_data.acct_no | string | event account number | Y |
| apf2doc.acct_contact | object | | N |
| apf2doc.acct_contact.first_name | string | contact first name | Y |
| apf2doc.acct_contact.phone | string | contact phone number | Y |
| apf2doc.acct_contact.email | string | contact email address | Y |
| apf2doc.notify_tmplt_group_data | object | | N |
| apf2doc.notify_tmplt_group_data.notify_tmplt_group | object | | N |
| apf2doc.notify_tmplt_group_data.notify_tmplt_group.notify_tmplt_group_id | string | group id of notification template | Y |
| apf2doc.master_plan_instance_data | object | | N |
| apf2doc.master_plan_instance_data.master_plan_instance | object | | N |
| apf2doc.master_plan_instance_data.master_plan_instance.client_master_plan_instance_id | string | master plan instance id of dunning event | Y |
| apf2doc.master_plan_instance_data.master_plan_instance.dunning_state | string | dunning state of the event | Y |
| apf2doc.master_plan_instance_data.master_plan_instance.dunning_step_description | string | detailed dunning step description of the event | Y |
| apf2doc.master_plan_instance_data.master_plan_instance.supp_plan_instance_data | object | | N |
| apf2doc.master_plan_instance_data.master_plan_instance.supp_plan_instance_data.spi_supp_fields_data | object | | N |
| apf2doc.master_plan_instance_data.master_plan_instance.supp_plan_instance_data.spi_supp_fields_data.spi_supp_field | object | | N |
| apf2doc.master_plan_instance_data.master_plan_instance.supp_plan_instance_data.spi_supp_fields_data.spi_supp_field.field_name | string | field name of the supplementary details | Y |
| apf2doc.master_plan_instance_data.master_plan_instance.supp_plan_instance_data.spi_supp_fields_data.spi_supp_field.field_value | string | field value of the supplementary details | Y |
| apf2doc.event_data | object | | N |
| apf2doc.event_data.event | object | | N |
| apf2doc.event_data.event.event_id | string | event id of the dunning event | Y |
Response
*Note: Acknowledgement response to consumer/SQS
"SUCCESS"