latestOpenAPI 3.0.02026-08-0832102256.6 KB

6097bc689e41

Transactions

Get all transactions of an Organization

Called by the Independent Software Vendor. Lists all the transactions in the database for the current organization that have not been read along with all process, refund and hpp transactions that have a remote ID and were performed in the last 24h.

get/transactions

Query parameters

limitinteger required

Specifies the limit of the returned list items. Size range - 0..100

offsetinteger required

Specifies the offset of the returned list items. Size range - 0..

remote_idstring

Specifies the provided remote_id

Headers

Authorizationstring api_id:api_token required

Needs to include Basic word before Base64 encoded api_id:api_token. The api_id is the identifier of the organization created on TAP; size range - up to 36 characters. The api_token is the unique token previously generated by TAP and provided securely to the organization; size range - 32. Example: Basic ODA5BVgrNdZkZmbiFlJlTThkYTA2eG00MzA5dHh1bWZnZgfdZDE=

Acceptstring required
Example:application/vnd.paymentfusion.v3.0.0+json

Specifies the requested API version. If this field is not specified or has an invalid format, the API will return an error. If the specified version does not exist, a 404 page will be displayed. Accepted values - application/vnd.paymentfusion.v3.0.0+json

Response

Success

totalinteger

The total number of transactions available.

limitinteger

The limit of the results array that was applied to this API call. Size range - 1..100

offsetinteger

The offset of the results array that was applied to this API call. Size range - 0..

vstring

The API version that was used to handle the request.

Example response

{
  "results": [
    {
      "remote_id": "string",
      "type": "string",
      "created_at": "string",
      "status": "string",
      "response": {
        "amount": "string",
        "serial_number": "string",
        "client_id": "string",
        "invoice": "string",
        "ip_address": "string",
        "user_name": "string",
        "customer_name": "string",
        "software_name": "string",
        "clerk_number": "string",
        "transaction_status": "string",
        "credit_card_token": "string",
        "card_type": "string",
        "card_expiration_date": "string",
        "masked_card_number": "string",
        "um_command": "string",
        "created_at": "string",
        "tip_amount": "string",
        "tip_method": "string",
        "cancel_requested": "string",
        "cancel_requested_at": "string",
        "gateway_identifier": "string",
        "gateway_reference_number": "string",
        "gateway_response_message": "string",
        "gateway_result_code": "string",
        "gateway_result_text": "string",
        "gateway_auth_code": "string",
        "merchant_id": "string",
        "billing_street": "string",
        "billing_city": "string",
        "billing_zip": "string",
        "billing_state": "string",
        "comments": "string",
        "description": "string",
        "customer_id": "string",
        "card_holder": "string",
        "gateway_ip": "string",
        "signature": "string",
        "card_hash": "string",
        "auth_amount": "string",
        "remaining_balance": "string",
        "emv_data": {
          "receipt": "string",
          "customer_verification_method": "string"
        },
        "remote_id": "string",
        "street_address": "string",
        "zip_code": "string",
        "input_method": "string",
        "bin_data": {
          "card_brand": "string",
          "issuing_org": "string",
          "card_type": "string",
          "card_category": "string",
          "issuing_country": "string",
          "issuing_country_code_a2": "string",
          "issuing_country_code_a3": "string",
          "issuing_phone": "string",
          "issuing_website": "string",
          "pan_length": "string",
          "issued_entity": "string",
          "is_regulated": "string"
        },
        "mid": "string",
        "tid": "string",
        "healthcare": {
          "iias_verified": "string",
          "healthcare_amount": "string",
          "prescription_amount": "string",
          "copay_amount": "string",
          "vision_amount": "string",
          "clinic_other_amount": "string",
          "dental_amount": "string",
          "transit_amount": "string",
          "cumulative_amount": "string"
        },
        "v": "string"
      }
    }
  ],
  "v": "string"
}