POST api/v1/client/cancellation

Cancel an existing client registration.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		CancelRequestModel	Required

Request Formats

application/json, text/json

Sample:

{
  "Authentication": {
    "Id": "170200123",
    "Key": "467512342123"
  },
  "Request": {
    "Cancel": "true (the only option available)"
  }
}

application/xml, text/xml

Sample:

<CancelationBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Authentication>
    <Id>170200123</Id>
    <Key>467512342123</Key>
  </Authentication>
  <Request>
    <Cancel>true (the only option available)</Cancel>
  </Request>
</CancelationBindingModel>

Response Information

Resource Description

RegistrationOutgoingModel

Name	Description	Type	Additional information
Message		MessageModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": {
    "Code": "(2 digit code reflecting result of request - 00 is good)",
    "Description": "(Message response in text depending upon request/result of request)"
  }
}

application/xml, text/xml

Sample:

<RegistrationOutgoingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Message>
    <Code>(2 digit code reflecting result of request - 00 is good)</Code>
    <Description>(Message response in text depending upon request/result of request)</Description>
  </Message>
</RegistrationOutgoingModel>