Epay

POST api/Epay/SendEmailForCharge

Create ePay and send email for charge to specified address

MethodEndpoint
SendEmailForCharge https://stgportalone.processonepayments.com/EPay/api/Epay/SendEmailForCharge

SendEmailForChargeRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

Communication key

string Yes

Max length: 100

Amount

Payment amount

decimal number No

Range: inclusive between 0.01 and 10000000

PolicyNumber

string No

Max length: 255

InsuredName

Insured name

string Yes

Max length: 100

RecipientEmailAddress

Recipient eMail address

string No

Max length: 100

ClientReferenceData

ClientReferenceData No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No

Max length: 50

UseConvenienceFee

Should Convenience Fee be used to process payments (default - true)

boolean No
AuthenticationKey

Instance authentication key (for ePay)

string Yes

* 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 Policy Number for Reference.

string No

Max length: 100

ClientReferenceData2

Used to pass External TransactionID

string No

Max length: 100

ClientReferenceData3

Used to pass location data such as office of where card was processed.

string No

Max length: 100

ClientReferenceData4

Client can pass anything needed in this field. This value is shown on Transaction Details screen.

string No

Max length: 100

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

Request Formats

 
                                
                                 {
  "CommunicationKey": "12A98464-2A40-4097-8FFA-5C6841BC5EB9",
  "Amount": 20.0,
  "PolicyNumber": null,
  "InsuredName": "John Smith",
  "RecipientEmailAddress": "[email protected]",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "AccountGroupCode": null,
  "UseConvenienceFee": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <SendEmailForChargeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <AccountGroupCode i:nil="true" />
  <Amount>20</Amount>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <CommunicationKey>12A98464-2A40-4097-8FFA-5C6841BC5EB9</CommunicationKey>
  <InsuredName>John Smith</InsuredName>
  <PolicyNumber i:nil="true" />
  <RecipientEmailAddress>[email protected]</RecipientEmailAddress>
  <UseConvenienceFee i:nil="true" />
</SendEmailForChargeRequest>

Response Information

SendEmailForChargeResponse

NameDescriptionTypeRequired*Additional information
EpayToken

ePay token

string No
PortalUrl

Portal URL

string No
ClientReferenceData

Client Reference Data

ClientReferenceData No
ResponseCode

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

{
  "EpayToken": "DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC",
  "PortalUrl": "https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<SendEmailForChargeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage>Success</ResponseMessage>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <EpayToken>DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC</EpayToken>
  <PortalUrl>https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA</PortalUrl>
</SendEmailForChargeResponse>

POST api/Epay/SendEmailForSavePaymentMethod

Create ePay and send email for saving payment method to specified address

MethodEndpoint
SendEmailForSavePaymentMethod https://stgportalone.processonepayments.com/EPay/api/Epay/SendEmailForSavePaymentMethod

SendEmailForSavePaymentMethodRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

Communication key

string Yes

Max length: 100

PolicyNumber

string No
InsuredName

Insured name

string Yes

Max length: 100

RecipientEmailAddress

Recipient eMail address

string No
ClientReferenceData

ClientReferenceData No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No

Max length: 50

AuthenticationKey

Instance authentication key (for ePay)

string Yes

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

Request Formats

 
                                
                                 {
  "CommunicationKey": "12A98464-2A40-4097-8FFA-5C6841BC5EB9",
  "PolicyNumber": null,
  "InsuredName": "John Smith",
  "RecipientEmailAddress": "[email protected]",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "AccountGroupCode": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <SendEmailForSavePaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <AccountGroupCode i:nil="true" />
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <CommunicationKey>12A98464-2A40-4097-8FFA-5C6841BC5EB9</CommunicationKey>
  <InsuredName>John Smith</InsuredName>
  <PolicyNumber i:nil="true" />
  <RecipientEmailAddress>[email protected]</RecipientEmailAddress>
</SendEmailForSavePaymentMethodRequest>

Response Information

SendEmailForSavePaymentMethodResponse

NameDescriptionTypeRequired*Additional information
EpayToken

ePay token

string No
PortalUrl

Portal URL

string No
ClientReferenceData

Client Reference Data

ClientReferenceData No
ResponseCode

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

{
  "EpayToken": "DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC",
  "PortalUrl": "https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<SendEmailForSavePaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage>Success</ResponseMessage>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <EpayToken>DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC</EpayToken>
  <PortalUrl>https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA</PortalUrl>
</SendEmailForSavePaymentMethodResponse>

POST api/Epay/SendEmailForChargeBySavedPaymentMethod

Create ePay and send email for charging by saved payment method to specified address

MethodEndpoint
SendEmailForChargeBySavedPaymentMethod https://stgportalone.processonepayments.com/EPay/api/Epay/SendEmailForChargeBySavedPaymentMethod

SendEmailForChargeBySavedPaymentMethodRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

Communication key

string Yes

Max length: 100

Amount

Payment amount

decimal number No

Range: inclusive between 0.01 and 10000000

PolicyNumber

string No
InsuredName

Insured name

string Yes

Max length: 100

RecipientEmailAddress

Recipient eMail address

string No
ProcessOneToken

ProcessOne token

string Yes
ClientReferenceData

ClientReferenceData No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No

Max length: 50

UseConvenienceFee

Should Convenience Fee be used to process payments (default - true)

boolean No
AuthenticationKey

Instance authentication key (for ePay)

string Yes

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

Request Formats

 
                                
                                 {
  "CommunicationKey": "12A98464-2A40-4097-8FFA-5C6841BC5EB9",
  "Amount": 20.0,
  "PolicyNumber": null,
  "InsuredName": "John Smith",
  "RecipientEmailAddress": "[email protected]",
  "ProcessOneToken": "519177A2-FC71-41F7-A7DA-F8F63379CAE6",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "AccountGroupCode": null,
  "UseConvenienceFee": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <SendEmailForChargeBySavedPaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <AccountGroupCode i:nil="true" />
  <Amount>20</Amount>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <CommunicationKey>12A98464-2A40-4097-8FFA-5C6841BC5EB9</CommunicationKey>
  <InsuredName>John Smith</InsuredName>
  <PolicyNumber i:nil="true" />
  <ProcessOneToken>519177A2-FC71-41F7-A7DA-F8F63379CAE6</ProcessOneToken>
  <RecipientEmailAddress>[email protected]</RecipientEmailAddress>
  <UseConvenienceFee i:nil="true" />
</SendEmailForChargeBySavedPaymentMethodRequest>

Response Information

SendEmailForChargeBySavedPaymentMethodResponse

NameDescriptionTypeRequired*Additional information
EpayToken

ePay token

string No
PortalUrl

Portal URL

string No
ClientReferenceData

Client Reference Data

ClientReferenceData No
ResponseCode

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

{
  "EpayToken": "DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC",
  "PortalUrl": "https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<SendEmailForChargeBySavedPaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage>Success</ResponseMessage>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <EpayToken>DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC</EpayToken>
  <PortalUrl>https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA</PortalUrl>
</SendEmailForChargeBySavedPaymentMethodResponse>

POST api/Epay/SendTextMessageForCharge

Create ePay and send SMS to specified phone number

MethodEndpoint
SendTextMessageForCharge https://stgportalone.processonepayments.com/EPay/api/Epay/SendTextMessageForCharge

SendTextMessageForChargeRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

Communication key

string Yes

Max length: 100

Amount

Payment amount

decimal number No

Range: inclusive between 0.01 and 10000000

PolicyNumber

string No
InsuredName

Insured name

string Yes

Max length: 100

RecipientPhoneNumber

Phone number

string Yes
ClientReferenceData

ClientReferenceData No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No

Max length: 50

UseConvenienceFee

Should Convenience Fee be used to process payments (default - true)

boolean No
AuthenticationKey

Instance authentication key (for ePay)

string Yes

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

Request Formats

 
                                
                                 {
  "CommunicationKey": "12A98464-2A40-4097-8FFA-5C6841BC5EB9",
  "Amount": 20.0,
  "PolicyNumber": null,
  "InsuredName": "John Smith",
  "RecipientPhoneNumber": "1234567890",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "AccountGroupCode": null,
  "UseConvenienceFee": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <SendTextMessageForChargeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <AccountGroupCode i:nil="true" />
  <Amount>20</Amount>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <CommunicationKey>12A98464-2A40-4097-8FFA-5C6841BC5EB9</CommunicationKey>
  <InsuredName>John Smith</InsuredName>
  <PolicyNumber i:nil="true" />
  <RecipientPhoneNumber>1234567890</RecipientPhoneNumber>
  <UseConvenienceFee i:nil="true" />
</SendTextMessageForChargeRequest>

Response Information

SendTextMessageForChargeResponse

NameDescriptionTypeRequired*Additional information
EpayToken

ePay token

string No
PortalUrl

Portal URL

string No
ClientReferenceData

Client Reference Data

ClientReferenceData No
ResponseCode

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

{
  "EpayToken": "DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC",
  "PortalUrl": "https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<SendTextMessageForChargeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage>Success</ResponseMessage>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <EpayToken>DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC</EpayToken>
  <PortalUrl>https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA</PortalUrl>
</SendTextMessageForChargeResponse>

POST api/Epay/SendTextMessageForSavePaymentMethod

Create ePay and send SMS for saving payment method to specified phone number

MethodEndpoint
SendTextMessageForSavePaymentMethod https://stgportalone.processonepayments.com/EPay/api/Epay/SendTextMessageForSavePaymentMethod

SendTextMessageForSavePaymentMethodRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

Communication key

string Yes

Max length: 100

PolicyNumber

string No
InsuredName

Insured name

string Yes

Max length: 100

RecipientPhoneNumber

Phone number

string Yes
ClientReferenceData

ClientReferenceData No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No

Max length: 50

AuthenticationKey

Instance authentication key (for ePay)

string Yes

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

Request Formats

 
                                
                                 {
  "CommunicationKey": "12A98464-2A40-4097-8FFA-5C6841BC5EB9",
  "PolicyNumber": null,
  "InsuredName": "John Smith",
  "RecipientPhoneNumber": "1234567890",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "AccountGroupCode": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <SendTextMessageForSavePaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <AccountGroupCode i:nil="true" />
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <CommunicationKey>12A98464-2A40-4097-8FFA-5C6841BC5EB9</CommunicationKey>
  <InsuredName>John Smith</InsuredName>
  <PolicyNumber i:nil="true" />
  <RecipientPhoneNumber>1234567890</RecipientPhoneNumber>
</SendTextMessageForSavePaymentMethodRequest>

Response Information

SendTextMessageForSavePaymentMethodResponse

NameDescriptionTypeRequired*Additional information
EpayToken

ePay token

string No
PortalUrl

Portal URL

string No
ClientReferenceData

Client Reference Data

ClientReferenceData No
ResponseCode

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

{
  "EpayToken": "DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC",
  "PortalUrl": "https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<SendTextMessageForSavePaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage>Success</ResponseMessage>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <EpayToken>DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC</EpayToken>
  <PortalUrl>https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA</PortalUrl>
</SendTextMessageForSavePaymentMethodResponse>

POST api/Epay/SendTextMessageForChargeBySavedPaymentMethod

Create ePay and send SMS for charging by saved payment method to specified phone number

MethodEndpoint
SendTextMessageForChargeBySavedPaymentMethod https://stgportalone.processonepayments.com/EPay/api/Epay/SendTextMessageForChargeBySavedPaymentMethod

SendTextMessageForChargeBySavedPaymentMethodRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

Communication key

string Yes

Max length: 100

Amount

Payment amount

decimal number No

Range: inclusive between 0.01 and 10000000

PolicyNumber

string No
InsuredName

Insured name

string Yes

Max length: 100

ProcessOneToken

ProcessOne token

string Yes
RecipientPhoneNumber

Phone number

string Yes
ClientReferenceData

ClientReferenceData No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No

Max length: 50

UseConvenienceFee

Should Convenience Fee be used to process payments (default - true)

boolean No
AuthenticationKey

Instance authentication key (for ePay)

string Yes

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

Request Formats

 
                                
                                 {
  "CommunicationKey": "12A98464-2A40-4097-8FFA-5C6841BC5EB9",
  "Amount": 20.0,
  "PolicyNumber": null,
  "InsuredName": "John Smith",
  "ProcessOneToken": "519177A2-FC71-41F7-A7DA-F8F63379CAE6",
  "RecipientPhoneNumber": "1234567890",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "AccountGroupCode": null,
  "UseConvenienceFee": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <SendTextMessageForChargeBySavedPaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <AccountGroupCode i:nil="true" />
  <Amount>20</Amount>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <CommunicationKey>12A98464-2A40-4097-8FFA-5C6841BC5EB9</CommunicationKey>
  <InsuredName>John Smith</InsuredName>
  <PolicyNumber i:nil="true" />
  <ProcessOneToken>519177A2-FC71-41F7-A7DA-F8F63379CAE6</ProcessOneToken>
  <RecipientPhoneNumber>1234567890</RecipientPhoneNumber>
  <UseConvenienceFee i:nil="true" />
</SendTextMessageForChargeBySavedPaymentMethodRequest>

Response Information

SendTextMessageForChargeBySavedPaymentMethodResponse

NameDescriptionTypeRequired*Additional information
EpayToken

ePay token

string No
PortalUrl

Portal URL

string No
ClientReferenceData

Client Reference Data

ClientReferenceData No
ResponseCode

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

{
  "EpayToken": "DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC",
  "PortalUrl": "https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<SendTextMessageForChargeBySavedPaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage>Success</ResponseMessage>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <EpayToken>DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC</EpayToken>
  <PortalUrl>https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA</PortalUrl>
</SendTextMessageForChargeBySavedPaymentMethodResponse>

POST api/Epay/CreateLinkForCharge

Create ePay portal link for charge

MethodEndpoint
CreateLinkForCharge https://stgportalone.processonepayments.com/EPay/api/Epay/CreateLinkForCharge

CreateLinkForChargeRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

Communication key

string Yes

Max length: 100

Amount

Payment amount

decimal number No

Range: inclusive between 0.01 and 10000000

PolicyNumber

string No
InsuredName

Insured name

string Yes

Max length: 100

ClientReferenceData

ClientReferenceData No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No

Max length: 50

UseConvenienceFee

Should Convenience Fee be used to process payments (default - true)

boolean No
AuthenticationKey

Instance authentication key (for ePay)

string Yes

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

Request Formats

 
                                
                                 {
  "CommunicationKey": "12A98464-2A40-4097-8FFA-5C6841BC5EB9",
  "Amount": 20.0,
  "PolicyNumber": null,
  "InsuredName": "John Smith",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "AccountGroupCode": null,
  "UseConvenienceFee": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <CreateLinkForChargeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <AccountGroupCode i:nil="true" />
  <Amount>20</Amount>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <CommunicationKey>12A98464-2A40-4097-8FFA-5C6841BC5EB9</CommunicationKey>
  <InsuredName>John Smith</InsuredName>
  <PolicyNumber i:nil="true" />
  <UseConvenienceFee i:nil="true" />
</CreateLinkForChargeRequest>

Response Information

CreateLinkForChargeResponse

NameDescriptionTypeRequired*Additional information
EpayToken

ePay token

string No
PortalUrl

Portal URL

string No
ClientReferenceData

Client Reference Data

ClientReferenceData No
ResponseCode

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

{
  "EpayToken": "DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC",
  "PortalUrl": "https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<CreateLinkForChargeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage>Success</ResponseMessage>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <EpayToken>DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC</EpayToken>
  <PortalUrl>https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA</PortalUrl>
</CreateLinkForChargeResponse>

POST api/Epay/CreateLinkForSavePaymentMethod

Create ePay portal link for saving payment method

MethodEndpoint
CreateLinkForSavePaymentMethod https://stgportalone.processonepayments.com/EPay/api/Epay/CreateLinkForSavePaymentMethod

CreateLinkForSavePaymentMethodRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

Communication key

string Yes

Max length: 100

PolicyNumber

string No
InsuredName

Insured name

string Yes

Max length: 100

ClientReferenceData

ClientReferenceData No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No

Max length: 50

AuthenticationKey

Instance authentication key (for ePay)

string Yes

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

Request Formats

 
                                
                                 {
  "CommunicationKey": "12A98464-2A40-4097-8FFA-5C6841BC5EB9",
  "PolicyNumber": null,
  "InsuredName": "John Smith",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "AccountGroupCode": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <CreateLinkForSavePaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <AccountGroupCode i:nil="true" />
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <CommunicationKey>12A98464-2A40-4097-8FFA-5C6841BC5EB9</CommunicationKey>
  <InsuredName>John Smith</InsuredName>
  <PolicyNumber i:nil="true" />
</CreateLinkForSavePaymentMethodRequest>

Response Information

CreateLinkForSavePaymentMethodResponse

NameDescriptionTypeRequired*Additional information
EpayToken

ePay token

string No
PortalUrl

Portal URL

string No
ClientReferenceData

Client Reference Data

ClientReferenceData No
ResponseCode

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

{
  "EpayToken": "DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC",
  "PortalUrl": "https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<CreateLinkForSavePaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage>Success</ResponseMessage>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <EpayToken>DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC</EpayToken>
  <PortalUrl>https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA</PortalUrl>
</CreateLinkForSavePaymentMethodResponse>

POST api/Epay/CreateLinkForChargeBySavedPaymentMethod

Create ePay portal link for charge by saved payment method

MethodEndpoint
CreateLinkForChargeBySavedPaymentMethod https://stgportalone.processonepayments.com/EPay/api/Epay/CreateLinkForChargeBySavedPaymentMethod

CreateLinkForChargeBySavedPaymentMethodRequest

NameDescriptionTypeRequired*Additional information
CommunicationKey

Communication key

string Yes

Max length: 100

Amount

Payment amount

decimal number No

Range: inclusive between 0.01 and 10000000

PolicyNumber

string No
InsuredName

Insured name

string Yes

Max length: 100

ProcessOneToken

ProcessOne token

string Yes
ClientReferenceData

ClientReferenceData No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No

Max length: 50

UseConvenienceFee

Should Convenience Fee be used to process payments (default - true)

boolean No
AuthenticationKey

Instance authentication key (for ePay)

string Yes

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

Request Formats

 
                                
                                 {
  "CommunicationKey": "12A98464-2A40-4097-8FFA-5C6841BC5EB9",
  "Amount": 20.0,
  "PolicyNumber": null,
  "InsuredName": "John Smith",
  "ProcessOneToken": "519177A2-FC71-41F7-A7DA-F8F63379CAE6",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "AccountGroupCode": null,
  "UseConvenienceFee": null,
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <CreateLinkForChargeBySavedPaymentMethodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <AccountGroupCode i:nil="true" />
  <Amount>20</Amount>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <CommunicationKey>12A98464-2A40-4097-8FFA-5C6841BC5EB9</CommunicationKey>
  <InsuredName>John Smith</InsuredName>
  <PolicyNumber i:nil="true" />
  <ProcessOneToken>519177A2-FC71-41F7-A7DA-F8F63379CAE6</ProcessOneToken>
  <UseConvenienceFee i:nil="true" />
</CreateLinkForChargeBySavedPaymentMethodRequest>

Response Information

CreateLinkForChargeBySavedPaymentMethodResponse

NameDescriptionTypeRequired*Additional information
EpayToken

ePay token

string No
PortalUrl

Portal URL

string No
ClientReferenceData

Client Reference Data

ClientReferenceData No
ResponseCode

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

{
  "EpayToken": "DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC",
  "PortalUrl": "https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA",
  "ClientReferenceData": {
    "ClientReferenceData1": "POC-00101-2",
    "ClientReferenceData2": "External Transaction ID",
    "ClientReferenceData3": "Location",
    "ClientReferenceData4": "anything"
  },
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<CreateLinkForChargeBySavedPaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage>Success</ResponseMessage>
  <ClientReferenceData>
    <ClientReferenceData1>POC-00101-2</ClientReferenceData1>
    <ClientReferenceData2>External Transaction ID</ClientReferenceData2>
    <ClientReferenceData3>Location</ClientReferenceData3>
    <ClientReferenceData4>anything</ClientReferenceData4>
  </ClientReferenceData>
  <EpayToken>DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC</EpayToken>
  <PortalUrl>https://stgportalone.processonepayments.com/Epay/Go/p8nPeMdLokyfjPQ2bPAlvA</PortalUrl>
</CreateLinkForChargeBySavedPaymentMethodResponse>

POST api/Epay/GetEpayInfo

Get ePay info

MethodEndpoint
GetEpayInfo https://stgportalone.processonepayments.com/EPay/api/Epay/GetEpayInfo

GetEpayInfoRequest

NameDescriptionTypeRequired*Additional information
EpayToken

ePay token

string Yes
AuthenticationKey

Instance authentication key (for ePay)

string Yes

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

Request Formats

 
                                
                                 {
  "EpayToken": "DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC",
  "AuthenticationKey": "Authentication Key"
}
                                
                                 <GetEpayInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <EpayToken>DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC</EpayToken>
</GetEpayInfoRequest>

Response Information

GetEpayInfoResponse

NameDescriptionTypeRequired*Additional information
EpayToken

ePay token

string No
EpayStatus

ePay status

EpayStatus No
TransactionId

ProcessOne Transaction ID

string No
Token

ProcessOne token

string No
MakeRecurringPaymentMethod

Flag for making payment method recurring

boolean No
ResponseCode

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.

EpayStatus

Possible enumeration values:

NameValueDescription
Undefined

0

Undefined

WaitingForResponse

1

Waiting for customer response

PaymentSuccessful

2

Payment successful

PaymentSubmitted

3

Obsolete. Use PaymentSuccessful instead

CardDeclined

4

Obsolete. Use PaymentFailed instead

PaymentFailed

5

Payment failed

Failed

6

Failed

Response Formats

{
  "EpayToken": "DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC",
  "EpayStatus": 1,
  "TransactionId": "12345",
  "Token": "519177A2-FC71-41F7-A7DA-F8F63379CAE6",
  "MakeRecurringPaymentMethod": false,
  "ResponseCode": "Success",
  "ResponseMessage": "Success"
}
<GetEpayInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Epay.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage>Success</ResponseMessage>
  <EpayStatus>WaitingForResponse</EpayStatus>
  <EpayToken>DFEAC0D8-6355-46BB-BE62-2520C8CF7AFC</EpayToken>
  <MakeRecurringPaymentMethod>false</MakeRecurringPaymentMethod>
  <Token>519177A2-FC71-41F7-A7DA-F8F63379CAE6</Token>
  <TransactionId>12345</TransactionId>
</GetEpayInfoResponse>