POST Transaction/Post

Request Information

URI Parameters

None.

Body Parameters

SquarePayment
NameDescriptionTypeAdditional information
merchant_id

string

None.

type

string

None.

event_id

string

None.

Created_at

string

None.

data

PaymentUpdatedEventData

None.

Request Formats

application/json, text/json

Sample:
{
  "merchant_id": "sample string 1",
  "type": "sample string 2",
  "event_id": "sample string 3",
  "Created_at": "sample string 4",
  "data": {
    "type": "sample string 1",
    "id": "sample string 2",
    "Object": {
      "payment": {
        "id": "sample string 1",
        "created_at": "sample string 2",
        "updated_at": "sample string 3",
        "amount_money": {
          "amount": 1,
          "currency": "sample string 2"
        },
        "tip_money": {
          "amount": 1,
          "currency": "sample string 2"
        },
        "total_money": {
          "amount": 1,
          "currency": "sample string 2"
        },
        "app_fee_money": {
          "amount": 1,
          "currency": "sample string 2"
        },
        "approved_money": {
          "amount": 1,
          "currency": "sample string 2"
        },
        "processing_fee": {
          "effective_at": "sample string 1",
          "type": "sample string 2",
          "amount_money": {
            "amount": 1,
            "currency": "sample string 2"
          }
        },
        "refunded_money": {
          "amount": 1,
          "currency": "sample string 2"
        },
        "status": "sample string 4",
        "delay_duration": "sample string 5",
        "delay_action": "sample string 6",
        "delayed_until": "sample string 7",
        "source_type": "sample string 8",
        "card_details": {
          "status": "sample string 1",
          "card": {
            "id": "sample string 1",
            "card_brand": "sample string 2",
            "last_4": "sample string 3",
            "exp_month": 4,
            "exp_year": 5,
            "cardholder_name": "sample string 6",
            "billing_address": {
              "address_line_1": "sample string 1",
              "address_line_2": "sample string 2",
              "address_line_3": "sample string 3",
              "locality": "sample string 4",
              "sublocality": "sample string 5",
              "sublocality_2": "sample string 6",
              "sublocality_3": "sample string 7",
              "administrative_district_level_1": "sample string 8",
              "administrative_district_level_2": "sample string 9",
              "administrative_district_level_3": "sample string 10",
              "postal_code": "sample string 11",
              "country": "sample string 12",
              "first_name": "sample string 13",
              "last_name": "sample string 14"
            },
            "fingerprint": "sample string 7",
            "customer_id3": "sample string 8",
            "merchant_id": "sample string 9",
            "reference_id": "sample string 10",
            "enabled": true,
            "card_type": "sample string 12",
            "prepaid_type": "sample string 13",
            "bin": "sample string 14",
            "version": 15,
            "card_co_brand": "sample string 16"
          },
          "entry_method": "sample string 2",
          "cvv_status": "sample string 3",
          "avs_status": "sample string 4",
          "auth_result_code": "sample string 5",
          "application_identifier": "sample string 6",
          "application_name": "sample string 7",
          "application_cryptogram": "sample string 8",
          "verification_method": "sample string 9",
          "verification_results": "sample string 10",
          "statement_description": "sample string 11",
          "device_details": {
            "device_id": "sample string 1",
            "device_installation_id": "sample string 2",
            "device_name": "sample string 3"
          },
          "card_payment_timeline": {
            "authorized_at": "sample string 1",
            "captured_at": "sample string 2",
            "voided_at": "sample string 3"
          },
          "refund_requires_card_presence": true,
          "errors": {
            "category": "sample string 1",
            "code": "sample string 2",
            "detail": "sample string 3",
            "field": "sample string 4"
          }
        },
        "cash_details": {
          "buyer_supplied_money": {
            "amount": 1,
            "currency": "sample string 2"
          },
          "change_back_money": {
            "amount": 1,
            "currency": "sample string 2"
          }
        },
        "bank_account_details": {
          "bank_name": "sample string 1",
          "transfer_type": "sample string 2",
          "account_ownership_type": "sample string 3",
          "fingerprint": "sample string 4",
          "country": "sample string 5",
          "statement_description": "sample string 6",
          "ach_details": {
            "routing_number": "sample string 1",
            "account_number_suffix": "sample string 2",
            "account_type": "sample string 3"
          },
          "errors": {
            "category": "sample string 1",
            "code": "sample string 2",
            "detail": "sample string 3",
            "field": "sample string 4"
          }
        },
        "external_details": {
          "type": "sample string 1",
          "source": "sample string 2",
          "source_id": "sample string 3",
          "source_fee_money": {
            "amount": 1,
            "currency": "sample string 2"
          }
        },
        "wallet_details": {
          "status": "sample string 1",
          "brand": "sample string 2",
          "cash_app_details": {
            "buyer_full_name": "sample string 1",
            "buyer_country_code": "sample string 2",
            "buyer_cashtag": "sample string 3"
          }
        },
        "buy_now_pay_later_details": {
          "brand": "sample string 1",
          "afterpay_details": {
            "email_address": "sample string 1"
          },
          "clearpay_details": {
            "email_address": "sample string 1"
          }
        },
        "square_account_details": {
          "payment_source_token": "sample string 1",
          "errors": {
            "category": "sample string 1",
            "code": "sample string 2",
            "detail": "sample string 3",
            "field": "sample string 4"
          }
        },
        "location_id": "sample string 9",
        "order_id": "sample string 10",
        "reference_id": "sample string 11",
        "customer_id": "sample string 12",
        "employee_id": "sample string 13",
        "team_member_id": "sample string 14",
        "refund_ids": "sample string 15",
        "risk_evaluation": {
          "created_at": "sample string 1",
          "risk_level": "sample string 2"
        },
        "terminal_checkout_id": "sample string 16",
        "buyer_email_address": "sample string 17",
        "billing_address": {
          "address_line_1": "sample string 1",
          "address_line_2": "sample string 2",
          "address_line_3": "sample string 3",
          "locality": "sample string 4",
          "sublocality": "sample string 5",
          "sublocality_2": "sample string 6",
          "sublocality_3": "sample string 7",
          "administrative_district_level_1": "sample string 8",
          "administrative_district_level_2": "sample string 9",
          "administrative_district_level_3": "sample string 10",
          "postal_code": "sample string 11",
          "country": "sample string 12",
          "first_name": "sample string 13",
          "last_name": "sample string 14"
        },
        "shipping_address": {
          "address_line_1": "sample string 1",
          "address_line_2": "sample string 2",
          "address_line_3": "sample string 3",
          "locality": "sample string 4",
          "sublocality": "sample string 5",
          "sublocality_2": "sample string 6",
          "sublocality_3": "sample string 7",
          "administrative_district_level_1": "sample string 8",
          "administrative_district_level_2": "sample string 9",
          "administrative_district_level_3": "sample string 10",
          "postal_code": "sample string 11",
          "country": "sample string 12",
          "first_name": "sample string 13",
          "last_name": "sample string 14"
        },
        "note": "sample string 18",
        "statement_description_identifier": "sample string 19",
        "capabilities": "sample string 20",
        "receipt_number": "sample string 21",
        "receipt_url": "sample string 22",
        "device_details": {
          "device_id": "sample string 1",
          "device_installation_id": "sample string 2",
          "device_name": "sample string 3"
        },
        "application_details": {
          "square_product": "sample string 1",
          "application_id": "sample string 2"
        },
        "is_offline_payment": true,
        "offline_payment_details": {
          "client_created_at": "sample string 1"
        },
        "version_token": "sample string 24"
      }
    }
  }
}

application/xml, text/xml

Sample:
<SquarePayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SquareEpos.Models">
  <Created_at>sample string 4</Created_at>
  <data>
    <Object>
      <payment>
        <amount_money>
          <amount>1</amount>
          <currency>sample string 2</currency>
        </amount_money>
        <app_fee_money>
          <amount>1</amount>
          <currency>sample string 2</currency>
        </app_fee_money>
        <application_details>
          <application_id>sample string 2</application_id>
          <square_product>sample string 1</square_product>
        </application_details>
        <approved_money>
          <amount>1</amount>
          <currency>sample string 2</currency>
        </approved_money>
        <bank_account_details>
          <account_ownership_type>sample string 3</account_ownership_type>
          <ach_details>
            <account_number_suffix>sample string 2</account_number_suffix>
            <account_type>sample string 3</account_type>
            <routing_number>sample string 1</routing_number>
          </ach_details>
          <bank_name>sample string 1</bank_name>
          <country>sample string 5</country>
          <errors>
            <category>sample string 1</category>
            <code>sample string 2</code>
            <detail>sample string 3</detail>
            <field>sample string 4</field>
          </errors>
          <fingerprint>sample string 4</fingerprint>
          <statement_description>sample string 6</statement_description>
          <transfer_type>sample string 2</transfer_type>
        </bank_account_details>
        <billing_address>
          <address_line_1>sample string 1</address_line_1>
          <address_line_2>sample string 2</address_line_2>
          <address_line_3>sample string 3</address_line_3>
          <administrative_district_level_1>sample string 8</administrative_district_level_1>
          <administrative_district_level_2>sample string 9</administrative_district_level_2>
          <administrative_district_level_3>sample string 10</administrative_district_level_3>
          <country>sample string 12</country>
          <first_name>sample string 13</first_name>
          <last_name>sample string 14</last_name>
          <locality>sample string 4</locality>
          <postal_code>sample string 11</postal_code>
          <sublocality>sample string 5</sublocality>
          <sublocality_2>sample string 6</sublocality_2>
          <sublocality_3>sample string 7</sublocality_3>
        </billing_address>
        <buy_now_pay_later_details>
          <afterpay_details>
            <email_address>sample string 1</email_address>
          </afterpay_details>
          <brand>sample string 1</brand>
          <clearpay_details>
            <email_address>sample string 1</email_address>
          </clearpay_details>
        </buy_now_pay_later_details>
        <buyer_email_address>sample string 17</buyer_email_address>
        <capabilities>sample string 20</capabilities>
        <card_details>
          <application_cryptogram>sample string 8</application_cryptogram>
          <application_identifier>sample string 6</application_identifier>
          <application_name>sample string 7</application_name>
          <auth_result_code>sample string 5</auth_result_code>
          <avs_status>sample string 4</avs_status>
          <card>
            <billing_address>
              <address_line_1>sample string 1</address_line_1>
              <address_line_2>sample string 2</address_line_2>
              <address_line_3>sample string 3</address_line_3>
              <administrative_district_level_1>sample string 8</administrative_district_level_1>
              <administrative_district_level_2>sample string 9</administrative_district_level_2>
              <administrative_district_level_3>sample string 10</administrative_district_level_3>
              <country>sample string 12</country>
              <first_name>sample string 13</first_name>
              <last_name>sample string 14</last_name>
              <locality>sample string 4</locality>
              <postal_code>sample string 11</postal_code>
              <sublocality>sample string 5</sublocality>
              <sublocality_2>sample string 6</sublocality_2>
              <sublocality_3>sample string 7</sublocality_3>
            </billing_address>
            <bin>sample string 14</bin>
            <card_brand>sample string 2</card_brand>
            <card_co_brand>sample string 16</card_co_brand>
            <card_type>sample string 12</card_type>
            <cardholder_name>sample string 6</cardholder_name>
            <customer_id3>sample string 8</customer_id3>
            <enabled>true</enabled>
            <exp_month>4</exp_month>
            <exp_year>5</exp_year>
            <fingerprint>sample string 7</fingerprint>
            <id>sample string 1</id>
            <last_4>sample string 3</last_4>
            <merchant_id>sample string 9</merchant_id>
            <prepaid_type>sample string 13</prepaid_type>
            <reference_id>sample string 10</reference_id>
            <version>15</version>
          </card>
          <card_payment_timeline>
            <authorized_at>sample string 1</authorized_at>
            <captured_at>sample string 2</captured_at>
            <voided_at>sample string 3</voided_at>
          </card_payment_timeline>
          <cvv_status>sample string 3</cvv_status>
          <device_details>
            <device_id>sample string 1</device_id>
            <device_installation_id>sample string 2</device_installation_id>
            <device_name>sample string 3</device_name>
          </device_details>
          <entry_method>sample string 2</entry_method>
          <errors>
            <category>sample string 1</category>
            <code>sample string 2</code>
            <detail>sample string 3</detail>
            <field>sample string 4</field>
          </errors>
          <refund_requires_card_presence>true</refund_requires_card_presence>
          <statement_description>sample string 11</statement_description>
          <status>sample string 1</status>
          <verification_method>sample string 9</verification_method>
          <verification_results>sample string 10</verification_results>
        </card_details>
        <cash_details>
          <buyer_supplied_money>
            <amount>1</amount>
            <currency>sample string 2</currency>
          </buyer_supplied_money>
          <change_back_money>
            <amount>1</amount>
            <currency>sample string 2</currency>
          </change_back_money>
        </cash_details>
        <created_at>sample string 2</created_at>
        <customer_id>sample string 12</customer_id>
        <delay_action>sample string 6</delay_action>
        <delay_duration>sample string 5</delay_duration>
        <delayed_until>sample string 7</delayed_until>
        <device_details>
          <device_id>sample string 1</device_id>
          <device_installation_id>sample string 2</device_installation_id>
          <device_name>sample string 3</device_name>
        </device_details>
        <employee_id>sample string 13</employee_id>
        <external_details>
          <source>sample string 2</source>
          <source_fee_money>
            <amount>1</amount>
            <currency>sample string 2</currency>
          </source_fee_money>
          <source_id>sample string 3</source_id>
          <type>sample string 1</type>
        </external_details>
        <id>sample string 1</id>
        <is_offline_payment>true</is_offline_payment>
        <location_id>sample string 9</location_id>
        <note>sample string 18</note>
        <offline_payment_details>
          <client_created_at>sample string 1</client_created_at>
        </offline_payment_details>
        <order_id>sample string 10</order_id>
        <processing_fee>
          <amount_money>
            <amount>1</amount>
            <currency>sample string 2</currency>
          </amount_money>
          <effective_at>sample string 1</effective_at>
          <type>sample string 2</type>
        </processing_fee>
        <receipt_number>sample string 21</receipt_number>
        <receipt_url>sample string 22</receipt_url>
        <reference_id>sample string 11</reference_id>
        <refund_ids>sample string 15</refund_ids>
        <refunded_money>
          <amount>1</amount>
          <currency>sample string 2</currency>
        </refunded_money>
        <risk_evaluation>
          <created_at>sample string 1</created_at>
          <risk_level>sample string 2</risk_level>
        </risk_evaluation>
        <shipping_address>
          <address_line_1>sample string 1</address_line_1>
          <address_line_2>sample string 2</address_line_2>
          <address_line_3>sample string 3</address_line_3>
          <administrative_district_level_1>sample string 8</administrative_district_level_1>
          <administrative_district_level_2>sample string 9</administrative_district_level_2>
          <administrative_district_level_3>sample string 10</administrative_district_level_3>
          <country>sample string 12</country>
          <first_name>sample string 13</first_name>
          <last_name>sample string 14</last_name>
          <locality>sample string 4</locality>
          <postal_code>sample string 11</postal_code>
          <sublocality>sample string 5</sublocality>
          <sublocality_2>sample string 6</sublocality_2>
          <sublocality_3>sample string 7</sublocality_3>
        </shipping_address>
        <source_type>sample string 8</source_type>
        <square_account_details>
          <errors>
            <category>sample string 1</category>
            <code>sample string 2</code>
            <detail>sample string 3</detail>
            <field>sample string 4</field>
          </errors>
          <payment_source_token>sample string 1</payment_source_token>
        </square_account_details>
        <statement_description_identifier>sample string 19</statement_description_identifier>
        <status>sample string 4</status>
        <team_member_id>sample string 14</team_member_id>
        <terminal_checkout_id>sample string 16</terminal_checkout_id>
        <tip_money>
          <amount>1</amount>
          <currency>sample string 2</currency>
        </tip_money>
        <total_money>
          <amount>1</amount>
          <currency>sample string 2</currency>
        </total_money>
        <updated_at>sample string 3</updated_at>
        <version_token>sample string 24</version_token>
        <wallet_details>
          <brand>sample string 2</brand>
          <cash_app_details>
            <buyer_cashtag>sample string 3</buyer_cashtag>
            <buyer_country_code>sample string 2</buyer_country_code>
            <buyer_full_name>sample string 1</buyer_full_name>
          </cash_app_details>
          <status>sample string 1</status>
        </wallet_details>
      </payment>
    </Object>
    <id>sample string 2</id>
    <type>sample string 1</type>
  </data>
  <event_id>sample string 3</event_id>
  <merchant_id>sample string 1</merchant_id>
  <type>sample string 2</type>
</SquarePayment>

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

Sample:

Sample not available.