The fields and formats needed for the Cancellation conversation are listed in this section.
Brokers have a way to modify a customer's telephone information with the Cancellation request. The request is verified, and any inaccuracies are returned for correction.


Method	POST
url	/cancellation

Request example

{
    "clientCode": "CC",
    "shopCode": "XXXX",
    "CancellationRequestType":{
        "brokerReference": "3607/015",
        "accountNumber": "910000016987",
        "returnOfPremiumValue":200.0,
        "cancellationReasonType":"4",
        "policyCancellationDate":"2023-02-01",
        "insurerReturnOfPremiumValue":353.35,
        "ropDeductionAmount":10.0
    }
}

Response example

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

Fields

CancellationRequestType

Node	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 Cancellations.
ReturnOfPremiumValue	Mandatory	Decimal		This is the amount (of the premium) that is returned in a cancellation, e.g. £139.67.
CancellationReasonType	Mandatory	String	2	This is the reason for the cancellation. See CancellationReasonType in Node Options
PolicyCancellationDate	Mandatory	Date		This is the date the policy was cancelled. Mandatory if CancellationReasonType is 2, 4,5,6,8,9,10,11,12,13,14 Optional if CancellationReasonType is 1,3,7
InsurerReturnOfPremiumV alue	Mandatory	Decimal		This is the full return of premium amount as provided by the insurer, e.g. £150.00.
RopDeductionAmount	Mandatory	Decimal		This is the amount of premium retained, e.g. £20.00.

CancellationResponseType

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