Card

POST api/Card/SaveMobile

This operation tokenizes all the required information for Apple Pay payment. Once the information is tokenized, you no longer have to provide us any sensitive information to make payments to this card. To initiate transactions with a token simply provide the token that is returned in the SaveMobile results in the ProcessOne RESTful API. Note: the first payment must be made with the token within 30 minutes of the SaveMobile request.

MethodEndpoint
SaveMobile https://stgportalone.processonepayments.com/Api/api/Card/SaveMobile

SaveMobileCardRequest

NameDescriptionTypeRequired*Additional information
MobilePaymentToken

Payment data object provided by Apple API.

string Yes
HolderAddress

Optional: Cardholder address

string No
HolderZip

Optional: Cardholder zip code

string No
HolderName

Optional: Cardholder name

string No
CallbackId

A callback id associated to save mobile transaction

string No
DisplayName

Optional: Display Name value for card, usually containing last 4 numbers. Acquired from Apple Pay PKPaymentToken object

string No
ClientReferenceData

ClientReferenceData

ClientReferenceData No
CustomerId

Client facing customer identifier

string No
PortalOneSessionKey

Session key

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ClientReferenceData

NameDescriptionTypeRequired*Additional information
ClientReferenceData1

Used to pass a reference number such as Policy, Quote, or Claim Number. The value will be searchable in the transaction search report.

string No
ClientReferenceData2

Used to pass and External TransactionId value. The value will be searchable in the transaction search report.

string No
ClientReferenceData3

Used to pass location data such as the office the transaction originated. The value will be searchable in the transaction search report.

string No
ClientReferenceData4

Used to pass additional information with the transaction. The value will be displayed in the transaction details.

string No
ClientReferenceData5

Used to pass additional reference source account data such as an account number for a multi-policy account. The value will be searchable in the transaction search report.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "MobilePaymentToken": "PaymentData property of PKPaymentToken",
  "HolderAddress": "620 Coolidge Drive Suite 200 Folsom, CA 95630",
  "HolderZip": "95630",
  "HolderName": "Janet Smith",
  "CallbackId": "5fd2a493-6be6-496f-9d58-f5ae8678d234",
  "DisplayName": "MasterCard 1471",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CustomerId": "D60039CB-DC29-4B9E-B290-C2C233155B9F",
  "PortalOneSessionKey": "e6e7c559-1eb9-482b-a16b-836e2283fb10"
}
                                
                                 <SaveMobileCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>e6e7c559-1eb9-482b-a16b-836e2283fb10</PortalOneSessionKey>
  <CallbackId>5fd2a493-6be6-496f-9d58-f5ae8678d234</CallbackId>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId>D60039CB-DC29-4B9E-B290-C2C233155B9F</CustomerId>
  <DisplayName>MasterCard 1471</DisplayName>
  <HolderAddress>620 Coolidge Drive Suite 200 Folsom, CA 95630</HolderAddress>
  <HolderName>Janet Smith</HolderName>
  <HolderZip>95630</HolderZip>
  <MobilePaymentToken>PaymentData property of PKPaymentToken</MobilePaymentToken>
</SaveMobileCardRequest>

Response Information

SaveMobileCardResponse

NameDescriptionTypeRequired*Additional information
TransactionId

ProcessOne transaction ID

string No
Token

ProcessOne Token

string No
TokenCreationTime

Time of token creation

date No
TimeZone

Time zone of TokenCreationTime

string No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "TransactionId": "123",
  "Token": "7826fcff-37e3-405c-9a2e-c5779e8ea978",
  "TokenCreationTime": "2020-10-27T04:59:42",
  "TimeZone": "PDT",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<SaveMobileCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <TimeZone>PDT</TimeZone>
  <Token>7826fcff-37e3-405c-9a2e-c5779e8ea978</Token>
  <TokenCreationTime>2020-10-27T04:59:42</TokenCreationTime>
  <TransactionId>123</TransactionId>
</SaveMobileCardResponse>

POST api/Card/ChargeMobile

This operation allows making a payment using the Apple Pay as a provider, which initiates a transfer of money from a particular customer account to the merchant account. You have to provide a valid payment token in your request.

MethodEndpoint
ChargeMobile https://stgportalone.processonepayments.com/Api/api/Card/ChargeMobile

ChargeMobileCardRequest

NameDescriptionTypeRequired*Additional information
MobilePaymentToken

Payment data object provided by Apple API.

string Yes
HolderAddress

Optional: Cardholder address

string No
HolderZip

Optional: Cardholder zip code

string No
HolderName

Optional: Cardholder name

string No
CallbackId

A callback id associated to charge mobile transaction

string No
DisplayName

Optional: Display Name value for card, usually containing last 4 numbers

string No
Amount

Charge amount

decimal number Yes
ChargeFee

Should we charge with fee (default - true)

boolean No
ConvenienceFeeType

Customizable convenience fee type that is matched with different types of transactions

string No
AccountGroupCode

Account group code

string No
ClientReferenceData

Client reference data

ClientReferenceData No
AcknowledgmentRequired

Indicates that successful payment must be acknowledged by a customer service

boolean No
CustomerId

Client facing customer identifier

string No
ExtendedParameters

The collection of key value pairs for optional parameters

Dictionary of string and string No
AccessToken

AccessToken

globally unique identifier No
PortalOneSessionKey

Session key

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "MobilePaymentToken": "PaymentData property of PKPaymentToken",
  "HolderAddress": "620 Coolidge Drive Suite 200 Folsom, CA 95630",
  "HolderZip": "95630",
  "HolderName": "Janet Smith",
  "CallbackId": "0fad17f3-4a77-46c3-96ad-8b505a0e1e41",
  "DisplayName": "MasterCard 1471",
  "Amount": 312.0,
  "ChargeFee": true,
  "ConvenienceFeeType": "Extra",
  "AccountGroupCode": "Default",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "AcknowledgmentRequired": null,
  "CustomerId": "D60039CB-DC29-4B9E-B290-C2C233155B9F",
  "ExtendedParameters": {
    "CustomerName": "John Smith"
  },
  "AccessToken": null,
  "PortalOneSessionKey": "611880f8-723c-4a37-8e33-98da95c19c92"
}
                                
                                 <ChargeMobileCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>611880f8-723c-4a37-8e33-98da95c19c92</PortalOneSessionKey>
  <AccessToken i:nil="true" />
  <AcknowledgmentRequired i:nil="true" />
  <Amount>0</Amount>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId>D60039CB-DC29-4B9E-B290-C2C233155B9F</CustomerId>
  <ExtendedParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>CustomerName</d2p1:Key>
      <d2p1:Value>John Smith</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ExtendedParameters>
  <AccountGroupCode>Default</AccountGroupCode>
  <Amount>312</Amount>
  <CallbackId>0fad17f3-4a77-46c3-96ad-8b505a0e1e41</CallbackId>
  <ChargeFee>true</ChargeFee>
  <ConvenienceFeeType>Extra</ConvenienceFeeType>
  <DisplayName>MasterCard 1471</DisplayName>
  <HolderAddress>620 Coolidge Drive Suite 200 Folsom, CA 95630</HolderAddress>
  <HolderName>Janet Smith</HolderName>
  <HolderZip>95630</HolderZip>
  <MobilePaymentToken>PaymentData property of PKPaymentToken</MobilePaymentToken>
</ChargeMobileCardRequest>

Response Information

ChargeMobileCardResponse

NameDescriptionTypeRequired*Additional information
AuthorizationCode

A gateway Authorization Code

string No
HolderName

Card Holder Name

string No
HolderZip

Card Holder Zip code

string No
TransactionId

Transaction ID

string No
TransactionDate

Transaction date and time

date No
TimeZone

Transaction time zone

string No
BatchNumber

Number of the batch

integer No
ReceiptId

Receipt ID

string No
AcknowledgmentDelivered

Indicates that successful payment has been acknowledged by a customer service

boolean No
ClientReferenceData1

Reference number such as Policy, Quote, or Claim Number for which payment is made.

string No
OriginalAmount

Original amount of the transaction

decimal number No
FeeAmount

Fee amount

decimal number No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "AuthorizationCode": "AUX225",
  "HolderName": "Janet Smith",
  "HolderZip": "95630",
  "TransactionId": "123",
  "TransactionDate": "2020-10-27T04:59:42",
  "TimeZone": "PDT",
  "BatchNumber": 10,
  "ReceiptId": "31aff4ff-23d0-4a62-bedb-3eca86817517",
  "AcknowledgmentDelivered": null,
  "ClientReferenceData1": null,
  "OriginalAmount": 0.0,
  "FeeAmount": 0.0,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<ChargeMobileCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <AcknowledgmentDelivered i:nil="true" />
  <BatchNumber>10</BatchNumber>
  <ClientReferenceData1 i:nil="true" />
  <FeeAmount>0</FeeAmount>
  <OriginalAmount>0</OriginalAmount>
  <ReceiptId>31aff4ff-23d0-4a62-bedb-3eca86817517</ReceiptId>
  <TimeZone>PDT</TimeZone>
  <TransactionDate>2020-10-27T04:59:42</TransactionDate>
  <TransactionId>123</TransactionId>
  <AuthorizationCode>AUX225</AuthorizationCode>
  <HolderName>Janet Smith</HolderName>
  <HolderZip>95630</HolderZip>
</ChargeMobileCardResponse>

POST api/Card/Save

This operation tokenizes all the required information about a credit card payment method. Once the card information is tokenized, you no longer have to provide us any sensitive credit card information. To initiate transactions with a tokenized card simply provide the token that is returned by our API.

MethodEndpoint
Save https://stgportalone.processonepayments.com/Api/api/Card/Save

SaveCardRequest

NameDescriptionTypeRequired*Additional information
Card

Card information

CardDetails Yes
CallbackId

A callback id associated to save transaction

string No
ClientReferenceData

Client reference data

ClientReferenceData No
CustomerId

Client facing customer identifier

string No
IsDefaultPaymentMethod

Is default payment method flag

boolean No
PortalOneSessionKey

Session key. Either Session key or Authentication key parameter is required

string No
PortalOneAuthenticationKey

Authentication key. Either Session key or Authentication key parameter is required

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

CardDetails

NameDescriptionTypeRequired*Additional information
ExpirationYear

Card expiration year

integer Yes
ExpirationMonth

Card expiration month

integer Yes
Holder

Card holder details

Customer No
Number

Card number

string No
ValidationValue

Card validation value

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Customer

NameDescriptionTypeRequired*Additional information
Name

Name

string No
Zip

Zip code

string No
Address

Address

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "Card": {
    "ExpirationYear": 2021,
    "ExpirationMonth": 1,
    "Holder": {
      "Name": "Janet Smith",
      "Zip": "95630",
      "Address": "620 Coolidge Drive Suite 200 Folsom, CA 95630"
    },
    "Number": "4111111111111111",
    "ValidationValue": "123"
  },
  "CallbackId": "c7c8b404-a8fb-48c8-b37a-8844afd170a7",
  "ClientReferenceData": {
    "ClientReferenceData1": "POL-123",
    "ClientReferenceData2": "12345",
    "ClientReferenceData3": null,
    "ClientReferenceData4": null,
    "ClientReferenceData5": null
  },
  "CustomerId": "D60039CB-DC29-4B9E-B290-C2C233155B9F",
  "IsDefaultPaymentMethod": false,
  "PortalOneSessionKey": "fba2f670-4076-4ef3-a379-a78ca693c555",
  "PortalOneAuthenticationKey": null
}
                                
                                 <SaveCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneAuthenticationKey i:nil="true" />
  <PortalOneSessionKey>fba2f670-4076-4ef3-a379-a78ca693c555</PortalOneSessionKey>
  <CallbackId>c7c8b404-a8fb-48c8-b37a-8844afd170a7</CallbackId>
  <ClientReferenceData>
    <ClientReferenceData1>POL-123</ClientReferenceData1>
    <ClientReferenceData2>12345</ClientReferenceData2>
    <ClientReferenceData3 i:nil="true" />
    <ClientReferenceData4 i:nil="true" />
    <ClientReferenceData5 i:nil="true" />
  </ClientReferenceData>
  <CustomerId>D60039CB-DC29-4B9E-B290-C2C233155B9F</CustomerId>
  <IsDefaultPaymentMethod>false</IsDefaultPaymentMethod>
  <Card>
    <ExpirationMonth>1</ExpirationMonth>
    <ExpirationYear>2021</ExpirationYear>
    <Holder>
      <Address>620 Coolidge Drive Suite 200 Folsom, CA 95630</Address>
      <Name>Janet Smith</Name>
      <Zip>95630</Zip>
    </Holder>
    <Number>4111111111111111</Number>
    <ValidationValue>123</ValidationValue>
  </Card>
</SaveCardRequest>

Response Information

SaveCardResponse

NameDescriptionTypeRequired*Additional information
BaseCardType

Base Card type

CreditCardType No
Token

ProcessOne payment token

string No
TokenCreationTime

Token creation date and time in merchant time zone

date No
TimeZone

Short time zone name with daylight saving time suffix

string No
PaymentMethodId

Related payment method identifier

integer No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

CreditCardType

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

Visa

1

Visa

MasterCard

2

MasterCard

AmericanExpress

3

AmericanExpress

Discover

4

Discover

PinlessDebitGeneric

5

PinlessDebitGeneric

Star

6

Star

Nyce

7

Nyce

Pulse

8

Pulse

Other

99

Other

Response Formats

{
  "BaseCardType": 1,
  "Token": "fcf4a9fa-3f15-444e-bbfe-5a8d6f69740e",
  "TokenCreationTime": "2020-10-27T04:59:43",
  "TimeZone": "PDT",
  "PaymentMethodId": null,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<SaveCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <PaymentMethodId i:nil="true" />
  <TimeZone>PDT</TimeZone>
  <Token>fcf4a9fa-3f15-444e-bbfe-5a8d6f69740e</Token>
  <TokenCreationTime>2020-10-27T04:59:43</TokenCreationTime>
  <BaseCardType>Visa</BaseCardType>
</SaveCardResponse>

Session

POST api/Session/Refresh

MethodEndpoint
Refresh https://stgportalone.processonepayments.com/Api/api/Session/Refresh

RefreshSessionRequest

NameDescriptionTypeRequired*Additional information
PortalOneSessionKey

Session key

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "PortalOneSessionKey": "sample string 1"
}
                                
                                 <RefreshSessionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>sample string 1</PortalOneSessionKey>
</RefreshSessionRequest>

Response Information

RefreshSessionResponse

NameDescriptionTypeRequired*Additional information
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<RefreshSessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
</RefreshSessionResponse>

POST api/Session/OpenApplePaySession

This method is used to contact Apple Pay server to open and validate Apple Pay payment session

MethodEndpoint
OpenApplePaySession https://stgportalone.processonepayments.com/Api/api/Session/OpenApplePaySession

OpenApplePaySessionRequest

NameDescriptionTypeRequired*Additional information
ValidationUrl

Url received from ApplePay JS

string Yes

Data type: Url

DisplayName

Name for displaying on the ApplePay payment sheet

string No
PortalOneSessionKey

Session key

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "ValidationUrl": "http://validationProvider:8080/ValidateApplePay",
  "DisplayName": "One Inc",
  "PortalOneSessionKey": "592be979-1d38-43c2-971d-5f5d1a660efe"
}
                                
                                 <OpenApplePaySessionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <PortalOneSessionKey>592be979-1d38-43c2-971d-5f5d1a660efe</PortalOneSessionKey>
  <DisplayName>One Inc</DisplayName>
  <ValidationUrl>http://validationProvider:8080/ValidateApplePay</ValidationUrl>
</OpenApplePaySessionRequest>

Response Information

OpenApplePaySessionResponse

NameDescriptionTypeRequired*Additional information
PaymentSession

Object returned from Apple Pay server which is used to open the session

string No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "PaymentSession": "3a10a52e-b6b0-4436-a148-b8894081c971",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<OpenApplePaySessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <PaymentSession>3a10a52e-b6b0-4436-a148-b8894081c971</PaymentSession>
</OpenApplePaySessionResponse>

POST api/Session/InitializeAuthenticationSession

This operation is used to initiate a temporary API session for authentication purposes and creates the PortalOneSessionKey. Once the PortalOneSessionKey is created, you can use it to access PortalOne API operations related to authentication.

MethodEndpoint
InitializeAuthenticationSession https://stgportalone.processonepayments.com/Api/api/Session/InitializeAuthenticationSession

InitializeAuthenticationSessionRequest

NameDescriptionTypeRequired*Additional information
ClientKey

Unique identifier of the client

string Yes
LoginType

Login type (Insured, Agent, Csr)

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "ClientKey": "sample string 1",
  "LoginType": "sample string 2"
}
                                
                                 <InitializeAuthenticationSessionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ClientKey>sample string 1</ClientKey>
  <LoginType>sample string 2</LoginType>
</InitializeAuthenticationSessionRequest>

Response Information

InitializeAuthenticationSessionResponse

NameDescriptionTypeRequired*Additional information
PortalOneSessionKey

Session key

string No
ResponseCode

Operation response code

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Response message

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "PortalOneSessionKey": "sample string 1",
  "ResponseCode": "sample string 2",
  "ResponseMessage": "sample string 3"
}
<InitializeAuthenticationSessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Api.Contracts.DataContracts">
  <ResponseCode>sample string 2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <PortalOneSessionKey>sample string 1</PortalOneSessionKey>
</InitializeAuthenticationSessionResponse>

TestGetSettingValue

GET api/TestGetSettingValue/GetPortalSettingValue?settingName={settingName}&clientKey={clientKey}&portalId={portalId}

MethodEndpoint
GetPortalSettingValue https://stgportalone.processonepayments.com/Api/api/TestGetSettingValue/GetPortalSettingValue?settingName={settingName}&clientKey={clientKey}&portalId={portalId}

URI Parameters

NameDescriptionTypeRequired*Additional information
settingName

string Yes
clientKey

string Yes
portalId

integer Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

String

Response Formats

"sample string 1"
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>

GET api/TestGetSettingValue/GetWorkflowSettingValue?settingName={settingName}&clientKey={clientKey}&workflowId={workflowId}

MethodEndpoint
GetWorkflowSettingValue https://stgportalone.processonepayments.com/Api/api/TestGetSettingValue/GetWorkflowSettingValue?settingName={settingName}&clientKey={clientKey}&workflowId={workflowId}

URI Parameters

NameDescriptionTypeRequired*Additional information
settingName

string Yes
clientKey

string Yes
workflowId

integer Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

String

Response Formats

"sample string 1"
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>