This section lists the fields and formats required in the PolicyStatus conversation. This provides a method to notify that a policy has been cancelled.


Method	POST
url	/policystatus

Request example

{
    "clientCode": "CX",
    "shopCode": "XXXX",
    "PolicyStatusRequestType":{
        "BrokerReference": "3607\/018",
        "accountNumber":"910000016998",
        "PolicyStatusType": "PolicyCancelled"
    }
}

Response example

{
    "data": {
        "policyStatusResponseType": {
            "responseStatus": 1,
            "responseStatusText": "Success"
        },
        "errors": null
    },
    "validationErrors": [],
    "error": -1,
    "error_description": null,
    "successful": true
}

Fields

PolicyStatusRequestType

Field	Required	Type	Max Length	Notes

BrokerReference	Mandatory	String	25	This is a unique reference provided by the broker to identify the applicant. The broker can use this reference to identify and locate the applicant on the BNPP PF system.
AccountNumber	Mandatory	String	15	This is the reference BNPP PF has assigned to the applicant as part of the new application process. It is used to locate the account and apply the transaction. It is mandatory to provide the AccountNumber and BrokerReference for PolicyStatus.
PolicyStatusType	Mandatory	Enum		This is the Policy Status. See PolicyStatusType in Node Options

CancellationResponseType

Node	Required	Type	Max Length	Notes
ResponseStatus	Mandatory	Enum		This is the status of a response See ResponseStatus in Option Values