POST api/Payments/ActisurePaymentSubmit

To submit payment details in Actisure

Request Information

URI Parameters

None.

Body Parameters

The retrieval params model.

ActisurePayement
NameDescriptionTypeAdditional information
PolicyId

integer

None.

PolicyExternalRef

string

None.

EntityId

integer

None.

ExternalRef

string

None.

ReceiptDescription

string

None.

ReceiptType

string

None.

AmountReceived

decimal number

None.

Currency

string

None.

ReceiptingEvent

string

None.

ReceiptReference

string

None.

AgentCode

string

None.

RequestedPortal

string

None.

RequestType

string

None.

PaymentReceivedDate

string

None.

PolicyEffectiveDate

string

None.

TransactionId

integer

None.

IsActive

boolean

None.

sessionKey

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PolicyId": 1,
  "PolicyExternalRef": "sample string 2",
  "EntityId": 3,
  "ExternalRef": "sample string 4",
  "ReceiptDescription": "sample string 5",
  "ReceiptType": "sample string 6",
  "AmountReceived": 7.1,
  "Currency": "sample string 8",
  "ReceiptingEvent": "sample string 9",
  "ReceiptReference": "sample string 10",
  "AgentCode": "sample string 11",
  "RequestedPortal": "sample string 12",
  "RequestType": "sample string 13",
  "PaymentReceivedDate": "sample string 14",
  "PolicyEffectiveDate": "sample string 15",
  "TransactionId": 16,
  "IsActive": true,
  "sessionKey": "sample string 18"
}

application/xml, text/xml

Sample:
<ActisurePayement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.Data.Models.Payments">
  <AgentCode>sample string 11</AgentCode>
  <AmountReceived>7.1</AmountReceived>
  <Currency>sample string 8</Currency>
  <EntityId>3</EntityId>
  <ExternalRef>sample string 4</ExternalRef>
  <IsActive>true</IsActive>
  <PaymentReceivedDate>sample string 14</PaymentReceivedDate>
  <PolicyEffectiveDate>sample string 15</PolicyEffectiveDate>
  <PolicyExternalRef>sample string 2</PolicyExternalRef>
  <PolicyId>1</PolicyId>
  <ReceiptDescription>sample string 5</ReceiptDescription>
  <ReceiptReference>sample string 10</ReceiptReference>
  <ReceiptType>sample string 6</ReceiptType>
  <ReceiptingEvent>sample string 9</ReceiptingEvent>
  <RequestType>sample string 13</RequestType>
  <RequestedPortal>sample string 12</RequestedPortal>
  <TransactionId>16</TransactionId>
  <sessionKey>sample string 18</sessionKey>
</ActisurePayement>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReceiptId

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.