POST api/PaymentGateway/Checkout

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Environment	string	None.
MerchantId	string	None.
PublicKey	string	None.
PrivateKey	string	None.
SubscriptionTransactionID	integer	None.
SubscriptionTypeID	integer	None.
SubscriptionBy	integer	None.
OrganizationID	integer	None.
TransactionType	string	None.
SubscriptionDate	date	None.
ExpiryDate	date	None.
BillingAddress	string	None.
PaidTotalAmount	decimal number	None.
OrderNumber	string	None.
PhoneNumber	string	None.
PaymentMethodNonce	string	None.
Status	string	None.
CardNumber	string	None.
SubscriptionPlanID	integer	None.
IsExpired	boolean	None.
SubscriptionType	Collection of SubscriptionType	None.

Request Formats

application/json, text/json

Sample:

{
  "environment": "sample string 1",
  "merchantId": "sample string 2",
  "publicKey": "sample string 3",
  "privateKey": "sample string 4",
  "subscriptionTransactionID": 1,
  "subscriptionTypeID": 5,
  "subscriptionBy": 1,
  "organizationID": 6,
  "transactionType": "sample string 7",
  "subscriptionDate": "2025-12-30T08:55:53.0697186+00:00",
  "expiryDate": "2025-12-30T08:55:53.0697186+00:00",
  "billingAddress": "sample string 8",
  "paidTotalAmount": 9.0,
  "orderNumber": "sample string 10",
  "phoneNumber": "sample string 11",
  "paymentMethodNonce": "sample string 12",
  "status": "sample string 13",
  "cardNumber": "sample string 14",
  "subscriptionPlanID": 15,
  "isExpired": true,
  "subscriptionType": [
    {
      "subscriptionTypeID": 1,
      "subscriptionName": "sample string 2",
      "subscriptionPlanID": 3,
      "subscriptionPlanName": "sample string 4",
      "paidAmount": 5.0,
      "transactionType": "sample string 6"
    },
    {
      "subscriptionTypeID": 1,
      "subscriptionName": "sample string 2",
      "subscriptionPlanID": 3,
      "subscriptionPlanName": "sample string 4",
      "paidAmount": 5.0,
      "transactionType": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<PaymentGateway xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Transportal.BAL.PaymnetGateway">
  <BillingAddress>sample string 8</BillingAddress>
  <CardNumber>sample string 14</CardNumber>
  <Environment>sample string 1</Environment>
  <ExpiryDate>2025-12-30T08:55:53.0697186+00:00</ExpiryDate>
  <IsExpired>true</IsExpired>
  <MerchantId>sample string 2</MerchantId>
  <OrderNumber>sample string 10</OrderNumber>
  <OrganizationID>6</OrganizationID>
  <PaidTotalAmount>9</PaidTotalAmount>
  <PaymentMethodNonce>sample string 12</PaymentMethodNonce>
  <PhoneNumber>sample string 11</PhoneNumber>
  <PrivateKey>sample string 4</PrivateKey>
  <PublicKey>sample string 3</PublicKey>
  <Status>sample string 13</Status>
  <SubscriptionBy>1</SubscriptionBy>
  <SubscriptionDate>2025-12-30T08:55:53.0697186+00:00</SubscriptionDate>
  <SubscriptionPlanID>15</SubscriptionPlanID>
  <SubscriptionTransactionID>1</SubscriptionTransactionID>
  <SubscriptionType>
    <SubscriptionType>
      <PaidAmount>5</PaidAmount>
      <SubscriptionName>sample string 2</SubscriptionName>
      <SubscriptionPlanID>3</SubscriptionPlanID>
      <SubscriptionPlanName>sample string 4</SubscriptionPlanName>
      <SubscriptionTypeID>1</SubscriptionTypeID>
      <TransactionType>sample string 6</TransactionType>
    </SubscriptionType>
    <SubscriptionType>
      <PaidAmount>5</PaidAmount>
      <SubscriptionName>sample string 2</SubscriptionName>
      <SubscriptionPlanID>3</SubscriptionPlanID>
      <SubscriptionPlanName>sample string 4</SubscriptionPlanName>
      <SubscriptionTypeID>1</SubscriptionTypeID>
      <TransactionType>sample string 6</TransactionType>
    </SubscriptionType>
  </SubscriptionType>
  <SubscriptionTypeID>5</SubscriptionTypeID>
  <TransactionType>sample string 7</TransactionType>
</PaymentGateway>

multipart/form-data

Sample:

<PaymentGateway xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Transportal.BAL.PaymnetGateway"><BillingAddress>sample string 8</BillingAddress><CardNumber>sample string 14</CardNumber><Environment>sample string 1</Environment><ExpiryDate>2025-12-30T08:55:53.0697186+00:00</ExpiryDate><IsExpired>true</IsExpired><MerchantId>sample string 2</MerchantId><OrderNumber>sample string 10</OrderNumber><OrganizationID>6</OrganizationID><PaidTotalAmount>9</PaidTotalAmount><PaymentMethodNonce>sample string 12</PaymentMethodNonce><PhoneNumber>sample string 11</PhoneNumber><PrivateKey>sample string 4</PrivateKey><PublicKey>sample string 3</PublicKey><Status>sample string 13</Status><SubscriptionBy>1</SubscriptionBy><SubscriptionDate>2025-12-30T08:55:53.0697186+00:00</SubscriptionDate><SubscriptionPlanID>15</SubscriptionPlanID><SubscriptionTransactionID>1</SubscriptionTransactionID><SubscriptionType><SubscriptionType><PaidAmount>5</PaidAmount><SubscriptionName>sample string 2</SubscriptionName><SubscriptionPlanID>3</SubscriptionPlanID><SubscriptionPlanName>sample string 4</SubscriptionPlanName><SubscriptionTypeID>1</SubscriptionTypeID><TransactionType>sample string 6</TransactionType></SubscriptionType><SubscriptionType><PaidAmount>5</PaidAmount><SubscriptionName>sample string 2</SubscriptionName><SubscriptionPlanID>3</SubscriptionPlanID><SubscriptionPlanName>sample string 4</SubscriptionPlanName><SubscriptionTypeID>1</SubscriptionTypeID><TransactionType>sample string 6</TransactionType></SubscriptionType></SubscriptionType><SubscriptionTypeID>5</SubscriptionTypeID><TransactionType>sample string 7</TransactionType></PaymentGateway>

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, multipart/form-data

Sample:

Sample not available.