POST api/Patch?accountID={accountID}&bankEntityId={bankEntityId}&userId={userId}&cardId={cardId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountID

string

Required

bankEntityId

string

Required

userId

globally unique identifier

Required

cardId

globally unique identifier

Required

Body Parameters

TransactionInfo
NameDescriptionTypeAdditional information
status

string

None.

payload

TransactionPayload

None.

results_id

string

None.

message

string

None.

timestamp

date

None.

Request Formats

application/json, text/json

Sample:
{
  "status": "sample string 1",
  "payload": {
    "transactions": [
      {
        "id": "sample string 1",
        "description": "sample string 2",
        "amount": 3.1,
        "currency_code": "sample string 4",
        "pending": true,
        "timestamp": "2023-09-04T04:59:49.8763284+00:00",
        "insights": {
          "description_cleansed": "sample string 1",
          "category": "sample string 2",
          "category_confidence": 3.1,
          "type": "sample string 4",
          "type_confidence": 5.1
        }
      },
      {
        "id": "sample string 1",
        "description": "sample string 2",
        "amount": 3.1,
        "currency_code": "sample string 4",
        "pending": true,
        "timestamp": "2023-09-04T04:59:49.8763284+00:00",
        "insights": {
          "description_cleansed": "sample string 1",
          "category": "sample string 2",
          "category_confidence": 3.1,
          "type": "sample string 4",
          "type_confidence": 5.1
        }
      }
    ],
    "type": "sample string 1",
    "reconnect_id": "sample string 2"
  },
  "results_id": "sample string 2",
  "message": "sample string 3",
  "timestamp": "2023-09-04T04:59:49.8763284+00:00"
}

application/xml, text/xml

Sample:
<TransactionInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.Integrations.Lean">
  <message>sample string 3</message>
  <payload>
    <reconnect_id>sample string 2</reconnect_id>
    <transactions>
      <Transaction>
        <amount>3.1</amount>
        <currency_code>sample string 4</currency_code>
        <description>sample string 2</description>
        <id>sample string 1</id>
        <insights>
          <category>sample string 2</category>
          <category_confidence>3.1</category_confidence>
          <description_cleansed>sample string 1</description_cleansed>
          <type>sample string 4</type>
          <type_confidence>5.1</type_confidence>
        </insights>
        <pending>true</pending>
        <timestamp>2023-09-04T04:59:49.8763284+00:00</timestamp>
      </Transaction>
      <Transaction>
        <amount>3.1</amount>
        <currency_code>sample string 4</currency_code>
        <description>sample string 2</description>
        <id>sample string 1</id>
        <insights>
          <category>sample string 2</category>
          <category_confidence>3.1</category_confidence>
          <description_cleansed>sample string 1</description_cleansed>
          <type>sample string 4</type>
          <type_confidence>5.1</type_confidence>
        </insights>
        <pending>true</pending>
        <timestamp>2023-09-04T04:59:49.8763284+00:00</timestamp>
      </Transaction>
    </transactions>
    <type>sample string 1</type>
  </payload>
  <results_id>sample string 2</results_id>
  <status>sample string 1</status>
  <timestamp>2023-09-04T04:59:49.8763284+00:00</timestamp>
</TransactionInfo>

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

Response Information

Resource Description

Collection of CardTransactionHistory
NameDescriptionTypeAdditional information
ID

globally unique identifier

None.

BankCardId

string

None.

TransactionId

string

None.

TransactionDate

date

None.

TransactionType

string

None.

Amount

decimal number

None.

Currency

string

None.

MerchantId

string

None.

StatusDescription

string

None.

Status

string

None.

BillAmount

decimal number

None.

BillCurrency

string

None.

BillConversionRateInAED

decimal number

None.

Address

string

None.

City

string

None.

PostalCode

string

None.

State

string

None.

Country

string

None.

UserId

globally unique identifier

None.

SponsorType

string

None.

LeanInsights

string

None.

description

string

None.

BankEntityId

string

None.

MCC

string

None.

Lean_Desc_Cleansed

string

None.

Lean_Category

string

None.

Lean_TXN_Type

string

None.

Notes

string

None.

NoteImage

string

None.

Type

integer

None.

IsDelete

boolean

None.

Network

string

None.

message_type

string

None.

card_first6_digits

string

None.

card_last4_digits

string

None.

card_expiry_date

string

None.

user_id

string

None.

acquirer_id

string

None.

merchant_id

string

None.

terminal_id

string

None.

stan

string

None.

rrn

string

None.

auth_id_response

string

None.

network_transaction_id

string

None.

conversion_rate_billing_account

string

None.

conversion_rate_billing

string

None.

eci

string

None.

status_description

string

None.

ecommerce_security_level

string

None.

card_entry

string

None.

pos_environment

string

None.

fallback

string

None.

pin_present

string

None.

moto

string

None.

recurring

string

None.

installment_transaction

string

None.

reversal_count

string

None.

clearing_count

string

None.

TransactionCategoryId

integer

None.

TransactionAmount

decimal number

None.

TransactionBillAmount

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": "4b27cf30-c46a-4532-9570-a1b3da6b8431",
    "BankCardId": "sample string 2",
    "TransactionId": "sample string 3",
    "TransactionDate": "2023-09-04T04:59:49.8763284+00:00",
    "TransactionType": "sample string 4",
    "Amount": 1.1,
    "Currency": "sample string 5",
    "MerchantId": "sample string 6",
    "StatusDescription": "sample string 7",
    "Status": "sample string 8",
    "BillAmount": 1.1,
    "BillCurrency": "sample string 9",
    "BillConversionRateInAED": 1.1,
    "Address": "sample string 10",
    "City": "sample string 11",
    "PostalCode": "sample string 12",
    "State": "sample string 13",
    "Country": "sample string 14",
    "UserId": "903bff1f-73a8-4087-869e-1fbc28e2b8a2",
    "SponsorType": "sample string 15",
    "LeanInsights": "sample string 16",
    "description": "sample string 17",
    "BankEntityId": "sample string 18",
    "MCC": "sample string 19",
    "Lean_Desc_Cleansed": "sample string 20",
    "Lean_Category": "sample string 21",
    "Lean_TXN_Type": "sample string 22",
    "Notes": "sample string 23",
    "NoteImage": "sample string 24",
    "Type": 1,
    "IsDelete": true,
    "Network": "sample string 25",
    "message_type": "sample string 26",
    "card_first6_digits": "sample string 27",
    "card_last4_digits": "sample string 28",
    "card_expiry_date": "sample string 29",
    "user_id": "sample string 30",
    "acquirer_id": "sample string 31",
    "merchant_id": "sample string 32",
    "terminal_id": "sample string 33",
    "stan": "sample string 34",
    "rrn": "sample string 35",
    "auth_id_response": "sample string 36",
    "network_transaction_id": "sample string 37",
    "conversion_rate_billing_account": "sample string 38",
    "conversion_rate_billing": "sample string 39",
    "eci": "sample string 40",
    "status_description": "sample string 41",
    "ecommerce_security_level": "sample string 42",
    "card_entry": "sample string 43",
    "pos_environment": "sample string 44",
    "fallback": "sample string 45",
    "pin_present": "sample string 46",
    "moto": "sample string 47",
    "recurring": "sample string 48",
    "installment_transaction": "sample string 49",
    "reversal_count": "sample string 50",
    "clearing_count": "sample string 51",
    "TransactionCategoryId": 1,
    "TransactionAmount": 1.1,
    "TransactionBillAmount": 1.1
  },
  {
    "ID": "4b27cf30-c46a-4532-9570-a1b3da6b8431",
    "BankCardId": "sample string 2",
    "TransactionId": "sample string 3",
    "TransactionDate": "2023-09-04T04:59:49.8763284+00:00",
    "TransactionType": "sample string 4",
    "Amount": 1.1,
    "Currency": "sample string 5",
    "MerchantId": "sample string 6",
    "StatusDescription": "sample string 7",
    "Status": "sample string 8",
    "BillAmount": 1.1,
    "BillCurrency": "sample string 9",
    "BillConversionRateInAED": 1.1,
    "Address": "sample string 10",
    "City": "sample string 11",
    "PostalCode": "sample string 12",
    "State": "sample string 13",
    "Country": "sample string 14",
    "UserId": "903bff1f-73a8-4087-869e-1fbc28e2b8a2",
    "SponsorType": "sample string 15",
    "LeanInsights": "sample string 16",
    "description": "sample string 17",
    "BankEntityId": "sample string 18",
    "MCC": "sample string 19",
    "Lean_Desc_Cleansed": "sample string 20",
    "Lean_Category": "sample string 21",
    "Lean_TXN_Type": "sample string 22",
    "Notes": "sample string 23",
    "NoteImage": "sample string 24",
    "Type": 1,
    "IsDelete": true,
    "Network": "sample string 25",
    "message_type": "sample string 26",
    "card_first6_digits": "sample string 27",
    "card_last4_digits": "sample string 28",
    "card_expiry_date": "sample string 29",
    "user_id": "sample string 30",
    "acquirer_id": "sample string 31",
    "merchant_id": "sample string 32",
    "terminal_id": "sample string 33",
    "stan": "sample string 34",
    "rrn": "sample string 35",
    "auth_id_response": "sample string 36",
    "network_transaction_id": "sample string 37",
    "conversion_rate_billing_account": "sample string 38",
    "conversion_rate_billing": "sample string 39",
    "eci": "sample string 40",
    "status_description": "sample string 41",
    "ecommerce_security_level": "sample string 42",
    "card_entry": "sample string 43",
    "pos_environment": "sample string 44",
    "fallback": "sample string 45",
    "pin_present": "sample string 46",
    "moto": "sample string 47",
    "recurring": "sample string 48",
    "installment_transaction": "sample string 49",
    "reversal_count": "sample string 50",
    "clearing_count": "sample string 51",
    "TransactionCategoryId": 1,
    "TransactionAmount": 1.1,
    "TransactionBillAmount": 1.1
  }
]

application/xml, text/xml

Sample:
<ArrayOfCardTransactionHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.EF">
  <CardTransactionHistory>
    <Address>sample string 10</Address>
    <Amount>1.1</Amount>
    <BankCardId>sample string 2</BankCardId>
    <BankEntityId>sample string 18</BankEntityId>
    <BillAmount>1.1</BillAmount>
    <BillConversionRateInAED>1.1</BillConversionRateInAED>
    <BillCurrency>sample string 9</BillCurrency>
    <City>sample string 11</City>
    <Country>sample string 14</Country>
    <Currency>sample string 5</Currency>
    <ID>4b27cf30-c46a-4532-9570-a1b3da6b8431</ID>
    <IsDelete>true</IsDelete>
    <LeanInsights>sample string 16</LeanInsights>
    <Lean_Category>sample string 21</Lean_Category>
    <Lean_Desc_Cleansed>sample string 20</Lean_Desc_Cleansed>
    <Lean_TXN_Type>sample string 22</Lean_TXN_Type>
    <MCC>sample string 19</MCC>
    <MerchantId>sample string 6</MerchantId>
    <Network>sample string 25</Network>
    <NoteImage>sample string 24</NoteImage>
    <Notes>sample string 23</Notes>
    <PostalCode>sample string 12</PostalCode>
    <SponsorType>sample string 15</SponsorType>
    <State>sample string 13</State>
    <Status>sample string 8</Status>
    <StatusDescription>sample string 7</StatusDescription>
    <TransactionAmount>1.1</TransactionAmount>
    <TransactionBillAmount>1.1</TransactionBillAmount>
    <TransactionCategoryId>1</TransactionCategoryId>
    <TransactionDate>2023-09-04T04:59:49.8763284+00:00</TransactionDate>
    <TransactionId>sample string 3</TransactionId>
    <TransactionType>sample string 4</TransactionType>
    <Type>1</Type>
    <UserId>903bff1f-73a8-4087-869e-1fbc28e2b8a2</UserId>
    <acquirer_id>sample string 31</acquirer_id>
    <auth_id_response>sample string 36</auth_id_response>
    <card_entry>sample string 43</card_entry>
    <card_expiry_date>sample string 29</card_expiry_date>
    <card_first6_digits>sample string 27</card_first6_digits>
    <card_last4_digits>sample string 28</card_last4_digits>
    <clearing_count>sample string 51</clearing_count>
    <conversion_rate_billing>sample string 39</conversion_rate_billing>
    <conversion_rate_billing_account>sample string 38</conversion_rate_billing_account>
    <description>sample string 17</description>
    <eci>sample string 40</eci>
    <ecommerce_security_level>sample string 42</ecommerce_security_level>
    <fallback>sample string 45</fallback>
    <installment_transaction>sample string 49</installment_transaction>
    <merchant_id>sample string 32</merchant_id>
    <message_type>sample string 26</message_type>
    <moto>sample string 47</moto>
    <network_transaction_id>sample string 37</network_transaction_id>
    <pin_present>sample string 46</pin_present>
    <pos_environment>sample string 44</pos_environment>
    <recurring>sample string 48</recurring>
    <reversal_count>sample string 50</reversal_count>
    <rrn>sample string 35</rrn>
    <stan>sample string 34</stan>
    <status_description>sample string 41</status_description>
    <terminal_id>sample string 33</terminal_id>
    <user_id>sample string 30</user_id>
  </CardTransactionHistory>
  <CardTransactionHistory>
    <Address>sample string 10</Address>
    <Amount>1.1</Amount>
    <BankCardId>sample string 2</BankCardId>
    <BankEntityId>sample string 18</BankEntityId>
    <BillAmount>1.1</BillAmount>
    <BillConversionRateInAED>1.1</BillConversionRateInAED>
    <BillCurrency>sample string 9</BillCurrency>
    <City>sample string 11</City>
    <Country>sample string 14</Country>
    <Currency>sample string 5</Currency>
    <ID>4b27cf30-c46a-4532-9570-a1b3da6b8431</ID>
    <IsDelete>true</IsDelete>
    <LeanInsights>sample string 16</LeanInsights>
    <Lean_Category>sample string 21</Lean_Category>
    <Lean_Desc_Cleansed>sample string 20</Lean_Desc_Cleansed>
    <Lean_TXN_Type>sample string 22</Lean_TXN_Type>
    <MCC>sample string 19</MCC>
    <MerchantId>sample string 6</MerchantId>
    <Network>sample string 25</Network>
    <NoteImage>sample string 24</NoteImage>
    <Notes>sample string 23</Notes>
    <PostalCode>sample string 12</PostalCode>
    <SponsorType>sample string 15</SponsorType>
    <State>sample string 13</State>
    <Status>sample string 8</Status>
    <StatusDescription>sample string 7</StatusDescription>
    <TransactionAmount>1.1</TransactionAmount>
    <TransactionBillAmount>1.1</TransactionBillAmount>
    <TransactionCategoryId>1</TransactionCategoryId>
    <TransactionDate>2023-09-04T04:59:49.8763284+00:00</TransactionDate>
    <TransactionId>sample string 3</TransactionId>
    <TransactionType>sample string 4</TransactionType>
    <Type>1</Type>
    <UserId>903bff1f-73a8-4087-869e-1fbc28e2b8a2</UserId>
    <acquirer_id>sample string 31</acquirer_id>
    <auth_id_response>sample string 36</auth_id_response>
    <card_entry>sample string 43</card_entry>
    <card_expiry_date>sample string 29</card_expiry_date>
    <card_first6_digits>sample string 27</card_first6_digits>
    <card_last4_digits>sample string 28</card_last4_digits>
    <clearing_count>sample string 51</clearing_count>
    <conversion_rate_billing>sample string 39</conversion_rate_billing>
    <conversion_rate_billing_account>sample string 38</conversion_rate_billing_account>
    <description>sample string 17</description>
    <eci>sample string 40</eci>
    <ecommerce_security_level>sample string 42</ecommerce_security_level>
    <fallback>sample string 45</fallback>
    <installment_transaction>sample string 49</installment_transaction>
    <merchant_id>sample string 32</merchant_id>
    <message_type>sample string 26</message_type>
    <moto>sample string 47</moto>
    <network_transaction_id>sample string 37</network_transaction_id>
    <pin_present>sample string 46</pin_present>
    <pos_environment>sample string 44</pos_environment>
    <recurring>sample string 48</recurring>
    <reversal_count>sample string 50</reversal_count>
    <rrn>sample string 35</rrn>
    <stan>sample string 34</stan>
    <status_description>sample string 41</status_description>
    <terminal_id>sample string 33</terminal_id>
    <user_id>sample string 30</user_id>
  </CardTransactionHistory>
</ArrayOfCardTransactionHistory>