Spreedly Documentation

List

GET /v1/transactions.<format> HTTPS/1.1
Host: core.spreedly.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/<format>

Example response has been truncated for brevity

HTTPS/1.1 200 OK

{
  "transactions": [
    {
      "token": "XWV55noINCMAAjXhr1ppj0kjvCd",
      "created_at": "2017-06-22T13:19:11Z",
      "updated_at": "2017-06-22T13:19:11Z",
      "succeeded": true,
      "transaction_type": "AddGateway",
      "state": "succeeded",
      "gateway": {
        "token": "CtehwikoMnllHsr3XFfAY1EzPkN",
        "gateway_type": "test",
        "description": null,
        "merchant_profile_key": null,
        "sub_merchant_key": null,
        "payment_methods": [
          "credit_card",
          "sprel",
          "third_party_token",
          "bank_account",
          "apple_pay",
          "google_pay"
        ],
        "state": "retained",
        "created_at": "2017-06-22T13:19:11Z",
        "updated_at": "2017-11-27T21:08:11Z",
        "name": "Spreedly Test",
        "characteristics": [
          "purchase",
          "authorize",
          "capture",
          "credit",
          "general_credit",
          "void",
          "adjust",
          "verify",
          "reference_purchase",
          "purchase_via_preauthorization",
          "offsite_purchase",
          "offsite_authorize",
          "offsite_synchronous_purchase",
          "offsite_synchronous_authorize",
          "3dsecure_purchase",
          "3dsecure_authorize",
          "3dsecure_2_mpi_purchase",
          "3dsecure_2_mpi_authorize",
          "store",
          "remove",
          "network_tokenization",
          "populate_mit_fields",
          "transaction_retry",
          "reference_authorization",
          "3dsecure_2_purchase",
          "3dsecure_2_authorize",
          "stored_credentials"
        ],
        "credentials": [

        ],
        "gateway_settings": {
        },
        "gateway_specific_fields": [
          "simulate_error",
          "simulate_decline",
          "idempotency_key",
          "mit_override_demo"
        ],
        "redacted": false,
        "sandbox": false,
        "mode": "default"
      },
      "message_key": "messages.transaction_succeeded",
      "message": "Succeeded!"
    },
    {
      "token": "Xqdiohe6ue8Zgb7I52j6BA843Y1",
      "created_at": "2017-06-22T14:16:23Z",
      "updated_at": "2017-06-22T14:16:23Z",
      "succeeded": true,
      "transaction_type": "AddGateway",
      "state": "succeeded",
      "gateway": {
        "token": "7NTzuQfnaNU2Jr4cVgOt7jfTVGq",
        "gateway_type": "test",
        "description": null,
        "merchant_profile_key": null,
        "sub_merchant_key": null,
        "payment_methods": [
          "credit_card",
          "sprel",
          "third_party_token",
          "bank_account",
          "apple_pay",
          "google_pay"
        ],
        "state": "retained",
        "created_at": "2017-06-22T14:16:23Z",
        "updated_at": "2017-11-27T21:44:49Z",
        "name": "Spreedly Test",
        "characteristics": [
          "purchase",
          "authorize",
          "capture",
          "credit",
          "general_credit",
          "void",
          "adjust",
          "verify",
          "reference_purchase",
          "purchase_via_preauthorization",
          "offsite_purchase",
          "offsite_authorize",
          "offsite_synchronous_purchase",
          "offsite_synchronous_authorize",
          "3dsecure_purchase",
          "3dsecure_authorize",
          "3dsecure_2_mpi_purchase",
          "3dsecure_2_mpi_authorize",
          "store",
          "remove",
          "network_tokenization",
          "populate_mit_fields",
          "transaction_retry",
          "reference_authorization",
          "3dsecure_2_purchase",
          "3dsecure_2_authorize",
          "stored_credentials"
        ],
        "credentials": [

        ],
        "gateway_settings": {
        },
        "gateway_specific_fields": [
          "simulate_error",
          "simulate_decline",
          "idempotency_key",
          "mit_override_demo"
        ],
        "redacted": false,
        "sandbox": false,
        "mode": "default"
      },
      "message_key": "messages.transaction_succeeded",
      "message": "Succeeded!"
    }
  ]
}

<transactions>
  <transaction>
    <token>XWV55noINCMAAjXhr1ppj0kjvCd</token>
    <created_at type="dateTime">2017-06-22T13:19:11Z</created_at>
    <updated_at type="dateTime">2017-06-22T13:19:11Z</updated_at>
    <succeeded type="boolean">true</succeeded>
    <transaction_type>AddGateway</transaction_type>
    <state>succeeded</state>
    <message key="messages.transaction_succeeded">Succeeded!</message>
    <gateway>
      <token>CtehwikoMnllHsr3XFfAY1EzPkN</token>
      <gateway_type>test</gateway_type>
      <name>Spreedly Test</name>
      <description nil="true"></description>
      <merchant_profile_key nil="true"></merchant_profile_key>
      <sub_merchant_key nil="true"></sub_merchant_key>
      <characteristics>
        <supports_purchase type="boolean">true</supports_purchase>
        <supports_authorize type="boolean">true</supports_authorize>
        <supports_capture type="boolean">true</supports_capture>
        <supports_credit type="boolean">true</supports_credit>
        <supports_general_credit type="boolean">true</supports_general_credit>
        <supports_void type="boolean">true</supports_void>
        <supports_adjust type="boolean">true</supports_adjust>
        <supports_verify type="boolean">true</supports_verify>
        <supports_reference_purchase type="boolean">true</supports_reference_purchase>
        <supports_purchase_via_preauthorization type="boolean">true</supports_purchase_via_preauthorization>
        <supports_offsite_purchase type="boolean">true</supports_offsite_purchase>
        <supports_offsite_authorize type="boolean">true</supports_offsite_authorize>
        <supports_offsite_synchronous_purchase type="boolean">true</supports_offsite_synchronous_purchase>
        <supports_offsite_synchronous_authorize type="boolean">true</supports_offsite_synchronous_authorize>
        <supports_3dsecure_purchase type="boolean">true</supports_3dsecure_purchase>
        <supports_3dsecure_authorize type="boolean">true</supports_3dsecure_authorize>
        <supports_3dsecure_2_mpi_purchase type="boolean">true</supports_3dsecure_2_mpi_purchase>
        <supports_3dsecure_2_mpi_authorize type="boolean">true</supports_3dsecure_2_mpi_authorize>
        <supports_store type="boolean">true</supports_store>
        <supports_remove type="boolean">true</supports_remove>
        <supports_fraud_review type="boolean">false</supports_fraud_review>
        <supports_network_tokenization type="boolean">true</supports_network_tokenization>
        <supports_populate_mit_fields type="boolean">true</supports_populate_mit_fields>
        <supports_inquire_by_gateway_transaction_id type="boolean">false</supports_inquire_by_gateway_transaction_id>
        <supports_inquire_by_order_id type="boolean">false</supports_inquire_by_order_id>
        <supports_transaction_retry type="boolean">true</supports_transaction_retry>
        <supports_stored_stored_credentials type="boolean">false</supports_stored_stored_credentials>
        <supports_reference_authorization type="boolean">true</supports_reference_authorization>
        <supports_3dsecure_2_purchase type="boolean">true</supports_3dsecure_2_purchase>
        <supports_3dsecure_2_authorize type="boolean">true</supports_3dsecure_2_authorize>
        <supports_stored_credentials type="boolean">true</supports_stored_credentials>
      </characteristics>
      <credentials>
      </credentials>
      <gateway_settings>
      </gateway_settings>
      <gateway_specific_fields>
        <gateway_specific_field>simulate_error</gateway_specific_field>
        <gateway_specific_field>simulate_decline</gateway_specific_field>
        <gateway_specific_field>idempotency_key</gateway_specific_field>
        <gateway_specific_field>mit_override_demo</gateway_specific_field>
      </gateway_specific_fields>
      <payment_methods>
        <payment_method>credit_card</payment_method>
        <payment_method>sprel</payment_method>
        <payment_method>third_party_token</payment_method>
        <payment_method>bank_account</payment_method>
        <payment_method>apple_pay</payment_method>
        <payment_method>google_pay</payment_method>
      </payment_methods>
      <state>retained</state>
      <redacted type="boolean">false</redacted>
      <sandbox type="boolean">false</sandbox>
      <mode>default</mode>
      <created_at type="dateTime">2017-06-22T13:19:11Z</created_at>
      <updated_at type="dateTime">2017-11-27T21:08:11Z</updated_at>
    </gateway>
  </transaction>
  <transaction>
    <token>Xqdiohe6ue8Zgb7I52j6BA843Y1</token>
    <created_at type="dateTime">2017-06-22T14:16:23Z</created_at>
    <updated_at type="dateTime">2017-06-22T14:16:23Z</updated_at>
    <succeeded type="boolean">true</succeeded>
    <transaction_type>AddGateway</transaction_type>
    <state>succeeded</state>
    <message key="messages.transaction_succeeded">Succeeded!</message>
    <gateway>
      <token>7NTzuQfnaNU2Jr4cVgOt7jfTVGq</token>
      <gateway_type>test</gateway_type>
      <name>Spreedly Test</name>
      <description nil="true"></description>
      <merchant_profile_key nil="true"></merchant_profile_key>
      <sub_merchant_key nil="true"></sub_merchant_key>
      <characteristics>
        <supports_purchase type="boolean">true</supports_purchase>
        <supports_authorize type="boolean">true</supports_authorize>
        <supports_capture type="boolean">true</supports_capture>
        <supports_credit type="boolean">true</supports_credit>
        <supports_general_credit type="boolean">true</supports_general_credit>
        <supports_void type="boolean">true</supports_void>
        <supports_adjust type="boolean">true</supports_adjust>
        <supports_verify type="boolean">true</supports_verify>
        <supports_reference_purchase type="boolean">true</supports_reference_purchase>
        <supports_purchase_via_preauthorization type="boolean">true</supports_purchase_via_preauthorization>
        <supports_offsite_purchase type="boolean">true</supports_offsite_purchase>
        <supports_offsite_authorize type="boolean">true</supports_offsite_authorize>
        <supports_offsite_synchronous_purchase type="boolean">true</supports_offsite_synchronous_purchase>
        <supports_offsite_synchronous_authorize type="boolean">true</supports_offsite_synchronous_authorize>
        <supports_3dsecure_purchase type="boolean">true</supports_3dsecure_purchase>
        <supports_3dsecure_authorize type="boolean">true</supports_3dsecure_authorize>
        <supports_3dsecure_2_mpi_purchase type="boolean">true</supports_3dsecure_2_mpi_purchase>
        <supports_3dsecure_2_mpi_authorize type="boolean">true</supports_3dsecure_2_mpi_authorize>
        <supports_store type="boolean">true</supports_store>
        <supports_remove type="boolean">true</supports_remove>
        <supports_fraud_review type="boolean">false</supports_fraud_review>
        <supports_network_tokenization type="boolean">true</supports_network_tokenization>
        <supports_populate_mit_fields type="boolean">true</supports_populate_mit_fields>
        <supports_inquire_by_gateway_transaction_id type="boolean">false</supports_inquire_by_gateway_transaction_id>
        <supports_inquire_by_order_id type="boolean">false</supports_inquire_by_order_id>
        <supports_transaction_retry type="boolean">true</supports_transaction_retry>
        <supports_stored_stored_credentials type="boolean">false</supports_stored_stored_credentials>
        <supports_reference_authorization type="boolean">true</supports_reference_authorization>
        <supports_3dsecure_2_purchase type="boolean">true</supports_3dsecure_2_purchase>
        <supports_3dsecure_2_authorize type="boolean">true</supports_3dsecure_2_authorize>
        <supports_stored_credentials type="boolean">true</supports_stored_credentials>
      </characteristics>
      <credentials>
      </credentials>
      <gateway_settings>
      </gateway_settings>
      <gateway_specific_fields>
        <gateway_specific_field>simulate_error</gateway_specific_field>
        <gateway_specific_field>simulate_decline</gateway_specific_field>
        <gateway_specific_field>idempotency_key</gateway_specific_field>
        <gateway_specific_field>mit_override_demo</gateway_specific_field>
      </gateway_specific_fields>
      <payment_methods>
        <payment_method>credit_card</payment_method>
        <payment_method>sprel</payment_method>
        <payment_method>third_party_token</payment_method>
        <payment_method>bank_account</payment_method>
        <payment_method>apple_pay</payment_method>
        <payment_method>google_pay</payment_method>
      </payment_methods>
      <state>retained</state>
      <redacted type="boolean">false</redacted>
      <sandbox type="boolean">false</sandbox>
      <mode>default</mode>
      <created_at type="dateTime">2017-06-22T14:16:23Z</created_at>
      <updated_at type="dateTime">2017-11-27T21:44:49Z</updated_at>
    </gateway>
  </transaction>
</transactions>

Retrieve an ordered and paginated list of all transactions in the authenticated environment.

URL Parameters

Parameter	Description
format required	One of `json` or `xml`
order	The order of the returned list. Default is `asc`, which returns the oldest records first. To list newer records first, use `desc`.
since_token	The token of the item to start from (e.g., the last token received in the previous list if iterating through records)
state	The transaction state on which to filter the returned list. Can be one of `succeeded`, `failed`, `gateway_processing_failed`, `gateway_processing_result_unknown`.
count	The number of transactions to return. By default returns 20, maximum allowed is 100.

Response Body

Notable response elements include:

Element	Description
transactions	Root element
❯ token	The token uniquely identifying the transaction at Spreedly
❯ succeeded	`true` if the transaction request was successfully executed, `false` otherwise
❯ message	A human-readable string indicating the result of the transaction
❯ transaction_type	The type of transaction, e.g., `Authorization`, `Capture`, `Credit`