POST api/paymentuilink

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PaymentFareDetails	PaymentFare	None.
Customer	CustomerData	None.
BookingInfo	BookingData	None.
PaymentAuthData	PaymentCredentials	None.
ActionsUrl	ProductActions	None.
Charges	Collection of Charges	None.
FormData	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "PaymentFareDetails": {
    "FareAmount": 1.0,
    "TaxAmount": 2.0,
    "TotalChargeAmount": 3.0,
    "CustomerPaymentCurrency": "sample string 4",
    "TotalAmount": 5.0,
    "PromoCodeValue": 6.0,
    "ExchangeRate": 7.0
  },
  "Customer": {
    "CustomerEmail": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Nationality": "sample string 4",
    "PhoneCountryCode": "sample string 5",
    "PhoneCodeCountry": "sample string 6",
    "CustomerPhone": "sample string 7",
    "IP": "sample string 8",
    "PaymentLocation": "sample string 9"
  },
  "BookingInfo": {
    "BookingDate": "2025-12-11T16:38:54.9188162+02:00",
    "CheckInDate": "2025-12-11T16:38:54.9188162+02:00",
    "Product": "sample string 3",
    "HGNumber": "sample string 4",
    "SearchID": "sample string 5",
    "Description": "sample string 6"
  },
  "PaymentAuthData": {
    "HGToken": "sample string 1",
    "HGTokenStatus": 0,
    "SuccessUrl": "sample string 2",
    "FailUrl": "sample string 3",
    "HGTrackId": "sample string 4",
    "PaymentMethod": "sample string 5",
    "PaymentToken": "sample string 6"
  },
  "ActionsUrl": {
    "ValidationUrl": "sample string 1",
    "PrePaymentUrl": "sample string 2",
    "PostPaymentUrl": "sample string 3"
  },
  "Charges": [
    {
      "ChargeName": "sample string 1",
      "ChargeCategory": "sample string 2",
      "ChargeValue": 1.0
    },
    {
      "ChargeName": "sample string 1",
      "ChargeCategory": "sample string 2",
      "ChargeValue": 1.0
    }
  ],
  "FormData": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<PaymentData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hogozati.PaymentTransaction.PrePayment.Models">
  <ActionsUrl>
    <PostPaymentUrl>sample string 3</PostPaymentUrl>
    <PrePaymentUrl>sample string 2</PrePaymentUrl>
    <ValidationUrl>sample string 1</ValidationUrl>
  </ActionsUrl>
  <BookingInfo>
    <BookingDate>2025-12-11T16:38:54.9188162+02:00</BookingDate>
    <CheckInDate>2025-12-11T16:38:54.9188162+02:00</CheckInDate>
    <Description>sample string 6</Description>
    <HGNumber>sample string 4</HGNumber>
    <Product>sample string 3</Product>
    <SearchID>sample string 5</SearchID>
  </BookingInfo>
  <Charges>
    <Charges>
      <ChargeCategory>sample string 2</ChargeCategory>
      <ChargeName>sample string 1</ChargeName>
      <ChargeValue>1</ChargeValue>
    </Charges>
    <Charges>
      <ChargeCategory>sample string 2</ChargeCategory>
      <ChargeName>sample string 1</ChargeName>
      <ChargeValue>1</ChargeValue>
    </Charges>
  </Charges>
  <Customer>
    <CustomerEmail>sample string 1</CustomerEmail>
    <CustomerPhone>sample string 7</CustomerPhone>
    <FirstName>sample string 2</FirstName>
    <IP>sample string 8</IP>
    <LastName>sample string 3</LastName>
    <Nationality>sample string 4</Nationality>
    <PaymentLocation>sample string 9</PaymentLocation>
    <PhoneCodeCountry>sample string 6</PhoneCodeCountry>
    <PhoneCountryCode>sample string 5</PhoneCountryCode>
  </Customer>
  <FormData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </FormData>
  <PaymentAuthData>
    <FailUrl>sample string 3</FailUrl>
    <HGToken>sample string 1</HGToken>
    <HGTokenStatus>Created</HGTokenStatus>
    <HGTrackId>sample string 4</HGTrackId>
    <PaymentMethod>sample string 5</PaymentMethod>
    <PaymentToken>sample string 6</PaymentToken>
    <SuccessUrl>sample string 2</SuccessUrl>
  </PaymentAuthData>
  <PaymentFareDetails>
    <CustomerPaymentCurrency>sample string 4</CustomerPaymentCurrency>
    <ExchangeRate>7</ExchangeRate>
    <FareAmount>1</FareAmount>
    <PromoCodeValue>6</PromoCodeValue>
    <TaxAmount>2</TaxAmount>
    <TotalAmount>5</TotalAmount>
    <TotalChargeAmount>3</TotalChargeAmount>
  </PaymentFareDetails>
</PaymentData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.