POST Transaction

Request Information

URI Parameters

None.

Body Parameters

TransactionRequest
Name Description Type Additional information
amount

decimal number

None.

method

string

None.

type

integer

None.

nonce

string

None.

test

string

None.

reference_transaction_id

string

None.

client_ip

string

None.

device_code

string

None.

market_code

string

None.

notes

string

None.

card

CardData

None.

emv

EmvData

None.

customer

CustomerData

None.

custom_fields

Collection of CustomFieldsData

None.

additional_data

Collection of AdditionalData

None.

additional_amount

Collection of AdditionalAmountData

None.

check

CheckData

None.

action_code

string

None.

level2_information

L2Information

None.

shipping_information

ShippingInformation

None.

invoice_number

string

None.

invoice_description

string

None.

purchase_order_number

string

None.

level3_information

Collection of L3Information

None.

transaction_response

TransResponse

None.

pos_id

string

None.

device_id

string

None.

internal_notes

string

None.

additional_transaction_code

string

None.

surcharge_amount

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "amount": 1.0,
  "method": "sample string 2",
  "type": 3,
  "nonce": "sample string 4",
  "test": "sample string 5",
  "reference_transaction_id": "sample string 6",
  "client_ip": "sample string 7",
  "device_code": "sample string 8",
  "market_code": "sample string 9",
  "notes": "sample string 10",
  "card": {
    "number": "sample string 1",
    "code": "sample string 2",
    "expiration_date": "sample string 3",
    "track_data": "sample string 4",
    "action_code": "sample string 5",
    "token": "sample string 6",
    "ksn": "sample string 7",
    "pin_block": "sample string 8",
    "auth_code": "sample string 9",
    "voucher_number": "sample string 10",
    "entry_mode": "sample string 11",
    "pin_ksn": "sample string 12",
    "payment_token": "sample string 13",
    "merchant_terminal_id": "sample string 14",
    "googlepay_token": "sample string 15",
    "applepay_token": "sample string 16"
  },
  "emv": {
    "emv_data": "sample string 1",
    "card_sequence_number": "sample string 2",
    "xcode_response_code": "sample string 3",
    "service_code": "sample string 4",
    "application_expiration_date": "sample string 5",
    "card_authentication_results_code": "sample string 6",
    "processing_indicator": "sample string 7",
    "processing_information": "sample string 8",
    "final_amount_indicator": "sample string 9",
    "pos_entry_mode": "sample string 10"
  },
  "customer": {
    "first_name": "sample string 1",
    "last_name": "sample string 2",
    "street_1": "sample string 3",
    "street_2": "sample string 4",
    "city": "sample string 5",
    "state": "sample string 6",
    "zip": "sample string 7",
    "country": "sample string 8",
    "phone_number": "sample string 9",
    "company": "sample string 10",
    "customer_id": "sample string 11",
    "email": "sample string 12",
    "email_receipt": "sample string 13",
    "notes": "sample string 14",
    "action_code": "sample string 15",
    "custom_fields": [
      {
        "id": "sample string 1",
        "value": "sample string 2",
        "UDFNumber": "sample string 3"
      },
      {
        "id": "sample string 1",
        "value": "sample string 2",
        "UDFNumber": "sample string 3"
      }
    ],
    "sms_receipt": 16
  },
  "custom_fields": [
    {
      "id": "sample string 1",
      "value": "sample string 2",
      "UDFNumber": "sample string 3"
    },
    {
      "id": "sample string 1",
      "value": "sample string 2",
      "UDFNumber": "sample string 3"
    }
  ],
  "additional_data": [
    {
      "id": "sample string 1",
      "value": "sample string 2"
    },
    {
      "id": "sample string 1",
      "value": "sample string 2"
    }
  ],
  "additional_amount": [
    {
      "add_amount": 1.0,
      "add_amt_type": 2
    },
    {
      "add_amount": 1.0,
      "add_amt_type": 2
    }
  ],
  "check": {
    "aba_code": "sample string 1",
    "account_number": "sample string 2",
    "account_type": "sample string 3",
    "bank_name": "sample string 4",
    "check_number": "sample string 5",
    "sec_code": "sample string 6",
    "action_code": "sample string 7",
    "token": "sample string 8",
    "payment_token": "sample string 9"
  },
  "action_code": "sample string 11",
  "level2_information": {
    "Invoice_discount_amount": "sample string 1",
    "purchaser_vat_registration_number": "sample string 2",
    "merchant_vat_registration_number": "sample string 3",
    "merchant_vat_invoice_reference_number": "sample string 4",
    "summary_commodity_code": "sample string 5",
    "tax_after_discount_indicator": "sample string 6",
    "vat_tax_rate": "sample string 7",
    "tax_amount": "sample string 8",
    "vat_tax_amount": "sample string 9",
    "taxable": 10
  },
  "shipping_information": {
    "first_name": "sample string 1",
    "last_name": "sample string 2",
    "company": "sample string 3",
    "address": "sample string 4",
    "city": "sample string 5",
    "state": "sample string 6",
    "zip": "sample string 7",
    "country": "sample string 8"
  },
  "invoice_number": "sample string 12",
  "invoice_description": "sample string 13",
  "purchase_order_number": "sample string 14",
  "level3_information": [
    {
      "item_code": "sample string 1",
      "item_name": "sample string 2",
      "item_description": "sample string 3",
      "item_quantity": "sample string 4",
      "item_unitprice": "sample string 5",
      "item_taxable": "sample string 6",
      "item_tax_rate": "sample string 7",
      "item_tax_amount": "sample string 8",
      "item_commodity_code": "sample string 9",
      "item_discount_amount": "sample string 10",
      "item_vat_rate": "sample string 11"
    },
    {
      "item_code": "sample string 1",
      "item_name": "sample string 2",
      "item_description": "sample string 3",
      "item_quantity": "sample string 4",
      "item_unitprice": "sample string 5",
      "item_taxable": "sample string 6",
      "item_tax_rate": "sample string 7",
      "item_tax_amount": "sample string 8",
      "item_commodity_code": "sample string 9",
      "item_discount_amount": "sample string 10",
      "item_vat_rate": "sample string 11"
    }
  ],
  "transaction_response": {
    "result_code": 1,
    "result_sub_code": "sample string 2",
    "result_text": "sample string 3",
    "transaction_id": "sample string 4",
    "transaction_uid": "sample string 5",
    "transaction_datetime": "sample string 6",
    "account_type": "sample string 7",
    "account_last_4": "sample string 8",
    "amount": "sample string 9",
    "approved_amount": "sample string 10",
    "method": "sample string 11",
    "auth_code": "sample string 12",
    "avs_result_code": "sample string 13",
    "code_result": "sample string 14",
    "type": "sample string 15",
    "expiration_date": "sample string 16",
    "token": "sample string 17",
    "emv": "sample string 18",
    "emv_tag_data": "sample string 19",
    "entry_mode": "sample string 20",
    "surcharge_amount": "sample string 21"
  },
  "pos_id": "sample string 15",
  "device_id": "sample string 16",
  "internal_notes": "sample string 17",
  "additional_transaction_code": "sample string 18",
  "surcharge_amount": 19.0
}

application/xml, text/xml

Sample:
<TransactionRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <amount>1</amount>
  <method>sample string 2</method>
  <type>3</type>
  <nonce>sample string 4</nonce>
  <test>sample string 5</test>
  <reference_transaction_id>sample string 6</reference_transaction_id>
  <client_ip>sample string 7</client_ip>
  <device_code>sample string 8</device_code>
  <market_code>sample string 9</market_code>
  <notes>sample string 10</notes>
  <card>
    <number>sample string 1</number>
    <code>sample string 2</code>
    <expiration_date>sample string 3</expiration_date>
    <track_data>sample string 4</track_data>
    <action_code>sample string 5</action_code>
    <token>sample string 6</token>
    <ksn>sample string 7</ksn>
    <pin_block>sample string 8</pin_block>
    <auth_code>sample string 9</auth_code>
    <voucher_number>sample string 10</voucher_number>
    <entry_mode>sample string 11</entry_mode>
    <pin_ksn>sample string 12</pin_ksn>
    <payment_token>sample string 13</payment_token>
    <merchant_terminal_id>sample string 14</merchant_terminal_id>
    <googlepay_token>sample string 15</googlepay_token>
    <applepay_token>sample string 16</applepay_token>
  </card>
  <emv>
    <emv_data>sample string 1</emv_data>
    <card_sequence_number>sample string 2</card_sequence_number>
    <xcode_response_code>sample string 3</xcode_response_code>
    <service_code>sample string 4</service_code>
    <application_expiration_date>sample string 5</application_expiration_date>
    <card_authentication_results_code>sample string 6</card_authentication_results_code>
    <processing_indicator>sample string 7</processing_indicator>
    <processing_information>sample string 8</processing_information>
    <final_amount_indicator>sample string 9</final_amount_indicator>
    <pos_entry_mode>sample string 10</pos_entry_mode>
  </emv>
  <customer>
    <first_name>sample string 1</first_name>
    <last_name>sample string 2</last_name>
    <street_1>sample string 3</street_1>
    <street_2>sample string 4</street_2>
    <city>sample string 5</city>
    <state>sample string 6</state>
    <zip>sample string 7</zip>
    <country>sample string 8</country>
    <phone_number>sample string 9</phone_number>
    <company>sample string 10</company>
    <customer_id>sample string 11</customer_id>
    <email>sample string 12</email>
    <email_receipt>sample string 13</email_receipt>
    <notes>sample string 14</notes>
    <action_code>sample string 15</action_code>
    <custom_fields>
      <CustomFieldsData>
        <id>sample string 1</id>
        <value>sample string 2</value>
        <UDFNumber>sample string 3</UDFNumber>
      </CustomFieldsData>
      <CustomFieldsData>
        <id>sample string 1</id>
        <value>sample string 2</value>
        <UDFNumber>sample string 3</UDFNumber>
      </CustomFieldsData>
    </custom_fields>
    <sms_receipt>16</sms_receipt>
  </customer>
  <custom_fields>
    <CustomFieldsData>
      <id>sample string 1</id>
      <value>sample string 2</value>
      <UDFNumber>sample string 3</UDFNumber>
    </CustomFieldsData>
    <CustomFieldsData>
      <id>sample string 1</id>
      <value>sample string 2</value>
      <UDFNumber>sample string 3</UDFNumber>
    </CustomFieldsData>
  </custom_fields>
  <additional_data>
    <AdditionalData>
      <id>sample string 1</id>
      <value>sample string 2</value>
    </AdditionalData>
    <AdditionalData>
      <id>sample string 1</id>
      <value>sample string 2</value>
    </AdditionalData>
  </additional_data>
  <additional_amount>
    <AdditionalAmountData>
      <add_amount>1</add_amount>
      <add_amt_type>2</add_amt_type>
    </AdditionalAmountData>
    <AdditionalAmountData>
      <add_amount>1</add_amount>
      <add_amt_type>2</add_amt_type>
    </AdditionalAmountData>
  </additional_amount>
  <check>
    <aba_code>sample string 1</aba_code>
    <account_number>sample string 2</account_number>
    <account_type>sample string 3</account_type>
    <bank_name>sample string 4</bank_name>
    <check_number>sample string 5</check_number>
    <sec_code>sample string 6</sec_code>
    <action_code>sample string 7</action_code>
    <token>sample string 8</token>
    <payment_token>sample string 9</payment_token>
  </check>
  <action_code>sample string 11</action_code>
  <level2_information>
    <Invoice_discount_amount>sample string 1</Invoice_discount_amount>
    <purchaser_vat_registration_number>sample string 2</purchaser_vat_registration_number>
    <merchant_vat_registration_number>sample string 3</merchant_vat_registration_number>
    <merchant_vat_invoice_reference_number>sample string 4</merchant_vat_invoice_reference_number>
    <summary_commodity_code>sample string 5</summary_commodity_code>
    <tax_after_discount_indicator>sample string 6</tax_after_discount_indicator>
    <vat_tax_rate>sample string 7</vat_tax_rate>
    <tax_amount>sample string 8</tax_amount>
    <vat_tax_amount>sample string 9</vat_tax_amount>
    <taxable>10</taxable>
  </level2_information>
  <shipping_information>
    <first_name>sample string 1</first_name>
    <last_name>sample string 2</last_name>
    <company>sample string 3</company>
    <address>sample string 4</address>
    <city>sample string 5</city>
    <state>sample string 6</state>
    <zip>sample string 7</zip>
    <country>sample string 8</country>
  </shipping_information>
  <invoice_number>sample string 12</invoice_number>
  <invoice_description>sample string 13</invoice_description>
  <purchase_order_number>sample string 14</purchase_order_number>
  <level3_information>
    <L3Information>
      <item_code>sample string 1</item_code>
      <item_name>sample string 2</item_name>
      <item_description>sample string 3</item_description>
      <item_quantity>sample string 4</item_quantity>
      <item_unitprice>sample string 5</item_unitprice>
      <item_taxable>sample string 6</item_taxable>
      <item_tax_rate>sample string 7</item_tax_rate>
      <item_tax_amount>sample string 8</item_tax_amount>
      <item_commodity_code>sample string 9</item_commodity_code>
      <item_discount_amount>sample string 10</item_discount_amount>
      <item_vat_rate>sample string 11</item_vat_rate>
    </L3Information>
    <L3Information>
      <item_code>sample string 1</item_code>
      <item_name>sample string 2</item_name>
      <item_description>sample string 3</item_description>
      <item_quantity>sample string 4</item_quantity>
      <item_unitprice>sample string 5</item_unitprice>
      <item_taxable>sample string 6</item_taxable>
      <item_tax_rate>sample string 7</item_tax_rate>
      <item_tax_amount>sample string 8</item_tax_amount>
      <item_commodity_code>sample string 9</item_commodity_code>
      <item_discount_amount>sample string 10</item_discount_amount>
      <item_vat_rate>sample string 11</item_vat_rate>
    </L3Information>
  </level3_information>
  <transaction_response>
    <result_code>1</result_code>
    <result_sub_code>sample string 2</result_sub_code>
    <result_text>sample string 3</result_text>
    <transaction_id>sample string 4</transaction_id>
    <transaction_uid>sample string 5</transaction_uid>
    <transaction_datetime>sample string 6</transaction_datetime>
    <account_type>sample string 7</account_type>
    <account_last_4>sample string 8</account_last_4>
    <amount>sample string 9</amount>
    <approved_amount>sample string 10</approved_amount>
    <method>sample string 11</method>
    <auth_code>sample string 12</auth_code>
    <avs_result_code>sample string 13</avs_result_code>
    <code_result>sample string 14</code_result>
    <type>sample string 15</type>
    <expiration_date>sample string 16</expiration_date>
    <token>sample string 17</token>
    <emv>sample string 18</emv>
    <emv_tag_data>sample string 19</emv_tag_data>
    <entry_mode>sample string 20</entry_mode>
    <surcharge_amount>sample string 21</surcharge_amount>
  </transaction_response>
  <pos_id>sample string 15</pos_id>
  <device_id>sample string 16</device_id>
  <internal_notes>sample string 17</internal_notes>
  <additional_transaction_code>sample string 18</additional_transaction_code>
  <surcharge_amount>19</surcharge_amount>
</TransactionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
Name Description Type Additional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.