POST api/Payment/GetHostedPaymentPageURL/{brand}/{jurisdiction}/{CallerID}

Request Information

URI Parameters

Name	Type	Additional information
brand	string	Required
jurisdiction	string	Required
CallerID	string	Required

Body Parameters

HostedPaymentPageRequestParameters

Name	Type	Additional information
BillingSystemCustomerId	string	None.
ExternalEnrollmentId	string	None.
SFEnrollmentId	string	None.
SFAccountId	string	None.
ClientApp	string	None.
PaymentType	string	None.
TransactionType	string	None.
PaymentAmount	decimal number	None.
ScheduledPaymentDate	string	None.
CreatedBy	string	None.
SetupAutoPay	string	None.
RequestedBy	string	None.
ForceLanguage	string	None.
MitMsgType	string	None.
ForbidPrepaidCardForAutopay	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "BillingSystemCustomerId": "sample string 1",
  "ExternalEnrollmentId": "sample string 2",
  "SFEnrollmentId": "sample string 3",
  "SFAccountId": "sample string 4",
  "ClientApp": "sample string 5",
  "PaymentType": "sample string 6",
  "TransactionType": "sample string 7",
  "PaymentAmount": 1.0,
  "ScheduledPaymentDate": "sample string 8",
  "CreatedBy": "sample string 9",
  "SetupAutoPay": "sample string 10",
  "RequestedBy": "sample string 11",
  "ForceLanguage": "sample string 12",
  "MitMsgType": "sample string 13",
  "ForbidPrepaidCardForAutopay": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HostedPaymentPageResponseBody

Name	Type	Additional information
Success	boolean	None.
StatusCode	string	None.
Message	string	None.
EventId	string	None.
Results	Collection of HPPResponseResults	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "StatusCode": "sample string 2",
  "Message": "sample string 3",
  "EventId": "sample string 4",
  "Results": [
    {
      "Uid": "sample string 1",
      "Url": "sample string 2"
    },
    {
      "Uid": "sample string 1",
      "Url": "sample string 2"
    }
  ]
}