POST api/Nymcard/TransactionWebhook

Request Information

URI Parameters

None.

Body Parameters

TransactionBody
NameDescriptionTypeAdditional information
event

string

None.

card_transaction

CardTransaction

None.

Request Formats

application/json, text/json

Sample:
{
  "event": "sample string 1",
  "card_transaction": {
    "id": "sample string 1",
    "parent_transaction_id": "sample string 2",
    "transaction_timestamp": "sample string 3",
    "network": "sample string 4",
    "message_type": "sample string 5",
    "transaction_type": "sample string 6",
    "transaction_description": "sample string 7",
    "transmission_date_time": "2024-10-01T10:00:57.4173406+00:00",
    "date_time_acquirer": "2024-10-01T10:00:57.4173406+00:00",
    "card_id": "sample string 10",
    "card_first6_digits": "sample string 11",
    "card_last4_digits": "sample string 12",
    "card_expiry_date": "sample string 13",
    "user_id": "sample string 14",
    "account_id1": "sample string 15",
    "card_product1": "sample string 16",
    "account_id2": "sample string 17",
    "card_product2": "sample string 18",
    "acquirer_id": "sample string 19",
    "merchant_id": "sample string 20",
    "mcc": "sample string 21",
    "merchant_name": "sample string 22",
    "merchant_city": "sample string 23",
    "merchant_country": "sample string 24",
    "terminal_id": "sample string 25",
    "stan": "sample string 26",
    "rrn": "sample string 27",
    "transaction_amount": 28.1,
    "billing_amount": 29.1,
    "auth_id_response": "sample string 30",
    "network_transaction_id": "sample string 31",
    "conversion_rate_billing_account": "sample string 32",
    "conversion_rate_billing": "sample string 33",
    "transaction_currency": "sample string 34",
    "fee_amount": 35,
    "billing_currency": "sample string 36",
    "original_amount_billing": "sample string 37",
    "status_code": "sample string 38",
    "transfer_id": "sample string 39",
    "card_entry": "sample string 40",
    "pos_environment": "sample string 41",
    "fallback": "sample string 42",
    "pin_present": "sample string 43",
    "moto": "sample string 44",
    "recurring": "sample string 45",
    "installment_transaction": "sample string 46",
    "reversal_count": "sample string 47",
    "clearing_count": "sample string 48",
    "eci": "sample string 49",
    "status_description": "sample string 50",
    "ecommerce_security_level": "sample string 51",
    "sender_user_id": "sample string 52"
  }
}

application/xml, text/xml

Sample:
<TransactionBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <card_transaction>
    <account_id1>sample string 15</account_id1>
    <account_id2>sample string 17</account_id2>
    <acquirer_id>sample string 19</acquirer_id>
    <auth_id_response>sample string 30</auth_id_response>
    <billing_amount>29.1</billing_amount>
    <billing_currency>sample string 36</billing_currency>
    <card_entry>sample string 40</card_entry>
    <card_expiry_date>sample string 13</card_expiry_date>
    <card_first6_digits>sample string 11</card_first6_digits>
    <card_id>sample string 10</card_id>
    <card_last4_digits>sample string 12</card_last4_digits>
    <card_product1>sample string 16</card_product1>
    <card_product2>sample string 18</card_product2>
    <clearing_count>sample string 48</clearing_count>
    <conversion_rate_billing>sample string 33</conversion_rate_billing>
    <conversion_rate_billing_account>sample string 32</conversion_rate_billing_account>
    <date_time_acquirer>2024-10-01T10:00:57.4173406+00:00</date_time_acquirer>
    <eci>sample string 49</eci>
    <ecommerce_security_level>sample string 51</ecommerce_security_level>
    <fallback>sample string 42</fallback>
    <fee_amount>35</fee_amount>
    <id>sample string 1</id>
    <installment_transaction>sample string 46</installment_transaction>
    <mcc>sample string 21</mcc>
    <merchant_city>sample string 23</merchant_city>
    <merchant_country>sample string 24</merchant_country>
    <merchant_id>sample string 20</merchant_id>
    <merchant_name>sample string 22</merchant_name>
    <message_type>sample string 5</message_type>
    <moto>sample string 44</moto>
    <network>sample string 4</network>
    <network_transaction_id>sample string 31</network_transaction_id>
    <original_amount_billing>sample string 37</original_amount_billing>
    <parent_transaction_id>sample string 2</parent_transaction_id>
    <pin_present>sample string 43</pin_present>
    <pos_environment>sample string 41</pos_environment>
    <recurring>sample string 45</recurring>
    <reversal_count>sample string 47</reversal_count>
    <rrn>sample string 27</rrn>
    <sender_user_id>sample string 52</sender_user_id>
    <stan>sample string 26</stan>
    <status_code>sample string 38</status_code>
    <status_description>sample string 50</status_description>
    <terminal_id>sample string 25</terminal_id>
    <transaction_amount>28.1</transaction_amount>
    <transaction_currency>sample string 34</transaction_currency>
    <transaction_description>sample string 7</transaction_description>
    <transaction_timestamp>sample string 3</transaction_timestamp>
    <transaction_type>sample string 6</transaction_type>
    <transfer_id>sample string 39</transfer_id>
    <transmission_date_time>2024-10-01T10:00:57.4173406+00:00</transmission_date_time>
    <user_id>sample string 14</user_id>
  </card_transaction>
  <event>sample string 1</event>
</TransactionBody>

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 'TransactionBody'.

Response Information

Resource Description

ResponseViewModel
NameDescriptionTypeAdditional information
Status

boolean

None.

StatusCode

integer

None.

Message

string

None.

Data

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": true,
  "StatusCode": 2,
  "Message": "sample string 3",
  "Data": {}
}

application/xml, text/xml

Sample:
<ResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <Data />
  <Message>sample string 3</Message>
  <Status>true</Status>
  <StatusCode>2</StatusCode>
</ResponseViewModel>