POST api/Topup/PayTabsCallback

Request Information

URI Parameters

None.

Body Parameters

PaytabResponse
NameDescriptionTypeAdditional information
tran_ref

string

None.

merchant_id

integer

None.

profile_id

integer

None.

cart_id

string

None.

cart_description

string

None.

cart_currency

string

None.

cart_amount

string

None.

tran_currency

string

None.

tran_total

string

None.

tran_type

string

None.

tran_class

string

None.

customer_details

CustomerDetails

None.

payment_result

PaymentResult

None.

payment_info

PaymentInfo

None.

ipn_trace

string

None.

Request Formats

application/json, text/json

Sample:
{
  "tran_ref": "sample string 1",
  "merchant_id": 2,
  "profile_id": 3,
  "cart_id": "sample string 4",
  "cart_description": "sample string 5",
  "cart_currency": "sample string 6",
  "cart_amount": "sample string 7",
  "tran_currency": "sample string 8",
  "tran_total": "sample string 9",
  "tran_type": "sample string 10",
  "tran_class": "sample string 11",
  "customer_details": {
    "name": "sample string 1",
    "email": "sample string 2",
    "phone": "sample string 3",
    "street1": "sample string 4",
    "city": "sample string 5",
    "state": "sample string 6",
    "country": "sample string 7",
    "zip": "sample string 8",
    "ip": "sample string 9"
  },
  "payment_result": {
    "response_status": "sample string 1",
    "response_code": "sample string 2",
    "response_message": "sample string 3",
    "cvv_result": "sample string 4",
    "avs_result": "sample string 5",
    "transaction_time": "2024-10-15T08:21:45.3177823+00:00"
  },
  "payment_info": {
    "payment_method": "sample string 1",
    "card_type": "sample string 2",
    "card_scheme": "sample string 3",
    "payment_description": "sample string 4",
    "expiryMonth": 5,
    "expiryYear": 6,
    "issuerCountry": "sample string 7",
    "issuerName": "sample string 8"
  },
  "ipn_trace": "sample string 12"
}

application/xml, text/xml

Sample:
<PaytabResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <cart_amount>sample string 7</cart_amount>
  <cart_currency>sample string 6</cart_currency>
  <cart_description>sample string 5</cart_description>
  <cart_id>sample string 4</cart_id>
  <customer_details>
    <city>sample string 5</city>
    <country>sample string 7</country>
    <email>sample string 2</email>
    <ip>sample string 9</ip>
    <name>sample string 1</name>
    <phone>sample string 3</phone>
    <state>sample string 6</state>
    <street1>sample string 4</street1>
    <zip>sample string 8</zip>
  </customer_details>
  <ipn_trace>sample string 12</ipn_trace>
  <merchant_id>2</merchant_id>
  <payment_info>
    <card_scheme>sample string 3</card_scheme>
    <card_type>sample string 2</card_type>
    <expiryMonth>5</expiryMonth>
    <expiryYear>6</expiryYear>
    <issuerCountry>sample string 7</issuerCountry>
    <issuerName>sample string 8</issuerName>
    <payment_description>sample string 4</payment_description>
    <payment_method>sample string 1</payment_method>
  </payment_info>
  <payment_result>
    <avs_result>sample string 5</avs_result>
    <cvv_result>sample string 4</cvv_result>
    <response_code>sample string 2</response_code>
    <response_message>sample string 3</response_message>
    <response_status>sample string 1</response_status>
    <transaction_time>2024-10-15T08:21:45.3177823+00:00</transaction_time>
  </payment_result>
  <profile_id>3</profile_id>
  <tran_class>sample string 11</tran_class>
  <tran_currency>sample string 8</tran_currency>
  <tran_ref>sample string 1</tran_ref>
  <tran_total>sample string 9</tran_total>
  <tran_type>sample string 10</tran_type>
</PaytabResponse>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PaytabResponse'.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>