POST api/ARInvoicesToCharge/GenerateAuthenticationKey

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CompanyId	string	None.
AccountId	integer	None.
authenticationKey	string	None.
expirationDateUtc	date	None.
actionGuid	string	None.
isSuccessful	boolean	None.
responseCode	integer	None.
durationInMilliseconds	integer	None.
HostedPaymentsAccountId	string	None.
HostedPaymentsResponse	string	None.
PaymentSourceType	string	None.
UseProductionUrl	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "CompanyId": "sample string 1",
  "AccountId": 2,
  "authenticationKey": "sample string 3",
  "expirationDateUtc": "2025-12-16T20:09:06.6405267+00:00",
  "actionGuid": "sample string 5",
  "isSuccessful": true,
  "responseCode": 7,
  "durationInMilliseconds": 8,
  "HostedPaymentsAccountId": "sample string 9",
  "HostedPaymentsResponse": "sample string 10",
  "PaymentSourceType": "sample string 11",
  "UseProductionUrl": true
}

application/xml, text/xml

Sample:

<AuthenticationKeyDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.PaymentGateway.FullSteam.DTO">
  <AccountId>2</AccountId>
  <CompanyId>sample string 1</CompanyId>
  <HostedPaymentsAccountId>sample string 9</HostedPaymentsAccountId>
  <HostedPaymentsResponse>sample string 10</HostedPaymentsResponse>
  <PaymentSourceType>sample string 11</PaymentSourceType>
  <UseProductionUrl>true</UseProductionUrl>
  <actionGuid>sample string 5</actionGuid>
  <authenticationKey>sample string 3</authenticationKey>
  <durationInMilliseconds>8</durationInMilliseconds>
  <expirationDateUtc>2025-12-16T20:09:06.6405267+00:00</expirationDateUtc>
  <isSuccessful>true</isSuccessful>
  <responseCode>7</responseCode>
</AuthenticationKeyDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AuthenticationKeyDTO

Name	Type	Additional information
CompanyId	string	None.
AccountId	integer	None.
authenticationKey	string	None.
expirationDateUtc	date	None.
actionGuid	string	None.
isSuccessful	boolean	None.
responseCode	integer	None.
durationInMilliseconds	integer	None.
HostedPaymentsAccountId	string	None.
HostedPaymentsResponse	string	None.
PaymentSourceType	string	None.
UseProductionUrl	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "CompanyId": "sample string 1",
  "AccountId": 2,
  "authenticationKey": "sample string 3",
  "expirationDateUtc": "2025-12-16T20:09:06.6718093+00:00",
  "actionGuid": "sample string 5",
  "isSuccessful": true,
  "responseCode": 7,
  "durationInMilliseconds": 8,
  "HostedPaymentsAccountId": "sample string 9",
  "HostedPaymentsResponse": "sample string 10",
  "PaymentSourceType": "sample string 11",
  "UseProductionUrl": true
}

application/xml, text/xml

Sample:

<AuthenticationKeyDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.PaymentGateway.FullSteam.DTO">
  <AccountId>2</AccountId>
  <CompanyId>sample string 1</CompanyId>
  <HostedPaymentsAccountId>sample string 9</HostedPaymentsAccountId>
  <HostedPaymentsResponse>sample string 10</HostedPaymentsResponse>
  <PaymentSourceType>sample string 11</PaymentSourceType>
  <UseProductionUrl>true</UseProductionUrl>
  <actionGuid>sample string 5</actionGuid>
  <authenticationKey>sample string 3</authenticationKey>
  <durationInMilliseconds>8</durationInMilliseconds>
  <expirationDateUtc>2025-12-16T20:09:06.6718093+00:00</expirationDateUtc>
  <isSuccessful>true</isSuccessful>
  <responseCode>7</responseCode>
</AuthenticationKeyDTO>