List Card Payments

Changed on
get/card_payments

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/card_payments
  • Auth
    HTTP bearer

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_idstring

Filter Card Payments to ones belonging to the specified Account.

card_idstring

Filter Card Payments to ones belonging to the specified Card.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

Response

Card Payment List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "account_id": "account_in71c4amph0vgo2qllky",
      "card_id": "card_oubs0hwk5rn6knuecxg2",
      "created_at": "2020-01-31T23:59:59Z",
      "digital_wallet_token_id": null,
      "elements": [
        {
          "card_authorization": {
            "actioner": "increase",
            "additional_amounts": {
              "clinic": null,
              "dental": null,
              "original": null,
              "prescription": null,
              "surcharge": {
                "amount": 10,
                "currency": "USD"
              },
              "total_cumulative": null,
              "total_healthcare": null,
              "transit": null,
              "unknown": null,
              "vision": null
            },
            "amount": 100,
            "card_payment_id": "card_payment_nd3k2kacrqjli8482ave",
            "currency": "USD",
            "digital_wallet_token_id": null,
            "direction": "settlement",
            "expires_at": "2020-01-31T23:59:59Z",
            "healthcare": null,
            "id": "card_authorization_6iqxap6ivd0fo5eu3i8x",
            "merchant_acceptor_id": "5665270011000168",
            "merchant_category_code": "5734",
            "merchant_city": "New York",
            "merchant_country": "US",
            "merchant_descriptor": "AMAZON.COM",
            "merchant_postal_code": "10045",
            "merchant_state": "NY",
            "network_details": {
              "category": "visa",
              "pulse": null,
              "visa": {
                "electronic_commerce_indicator": "secure_electronic_commerce",
                "point_of_service_entry_mode": "manual",
                "stand_in_processing_reason": null,
                "terminal_entry_capability": "magnetic_stripe"
              }
            },
            "network_identifiers": {
              "authorization_identification_response": null,
              "retrieval_reference_number": "785867080153",
              "trace_number": "487941",
              "transaction_id": "627199945183184"
            },
            "network_risk_score": 10,
            "original_card_payment_id": null,
            "pending_transaction_id": null,
            "physical_card_id": null,
            "presentment_amount": 100,
            "presentment_currency": "USD",
            "processing_category": "purchase",
            "real_time_decision_id": null,
            "scheme_fees": [
              {
                "amount": "0.137465",
                "created_at": "2020-01-31T23:59:59Z",
                "currency": "USD",
                "fee_type": "visa_corporate_acceptance_fee",
                "fixed_component": null,
                "variable_rate": "0.0002"
              }
            ],
            "terminal_id": "RCN5VNXS",
            "type": "card_authorization",
            "verification": {
              "card_verification_code": {
                "result": "match"
              },
              "cardholder_address": {
                "actual_line1": "33 Liberty Street",
                "actual_postal_code": "94131",
                "provided_line1": "33 Liberty Street",
                "provided_postal_code": "94132",
                "result": "postal_code_no_match_address_match"
              },
              "cardholder_name": null
            }
          },
          "category": "card_authorization",
          "created_at": "2020-01-31T23:59:59Z"
        },
        {
          "card_reversal": {
            "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x",
            "currency": "USD",
            "id": "card_reversal_8vr9qy60cgf5d0slpb68",
            "merchant_acceptor_id": "5665270011000168",
            "merchant_category_code": "5734",
            "merchant_city": "New York",
            "merchant_country": "US",
            "merchant_descriptor": "AMAZON.COM",
            "merchant_postal_code": "10045",
            "merchant_state": "NY",
            "network": "visa",
            "network_identifiers": {
              "authorization_identification_response": null,
              "retrieval_reference_number": "785867080153",
              "trace_number": "487941",
              "transaction_id": "627199945183184"
            },
            "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4",
            "presentment_currency": "USD",
            "reversal_amount": 20,
            "reversal_presentment_amount": 20,
            "reversal_reason": "reversed_by_customer",
            "scheme_fees": [
              {
                "amount": "0.137465",
                "created_at": "2020-01-31T23:59:59Z",
                "currency": "USD",
                "fee_type": "visa_corporate_acceptance_fee",
                "fixed_component": null,
                "variable_rate": "0.0002"
              }
            ],
            "terminal_id": "RCN5VNXS",
            "type": "card_reversal",
            "updated_authorization_amount": 80,
            "updated_authorization_presentment_amount": 80
          },
          "category": "card_reversal",
          "created_at": "2020-01-31T23:59:59Z"
        },
        {
          "card_increment": {
            "actioner": "increase",
            "additional_amounts": {
              "clinic": null,
              "dental": null,
              "original": null,
              "prescription": null,
              "surcharge": null,
              "total_cumulative": null,
              "total_healthcare": null,
              "transit": null,
              "unknown": null,
              "vision": null
            },
            "amount": 20,
            "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x",
            "currency": "USD",
            "id": "card_increment_6ztayc58j1od0rpebp3e",
            "network": "visa",
            "network_identifiers": {
              "authorization_identification_response": null,
              "retrieval_reference_number": "785867080153",
              "trace_number": "487941",
              "transaction_id": "627199945183184"
            },
            "network_risk_score": 10,
            "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4",
            "presentment_amount": 20,
            "presentment_currency": "USD",
            "real_time_decision_id": null,
            "scheme_fees": [
              {
                "amount": "0.137465",
                "created_at": "2020-01-31T23:59:59Z",
                "currency": "USD",
                "fee_type": "visa_corporate_acceptance_fee",
                "fixed_component": null,
                "variable_rate": "0.0002"
              }
            ],
            "type": "card_increment",
            "updated_authorization_amount": 120
          },
          "category": "card_increment",
          "created_at": "2020-01-31T23:59:59Z"
        },
        {
          "card_settlement": {
            "amount": 100,
            "card_authorization": null,
            "card_payment_id": "card_payment_nd3k2kacrqjli8482ave",
            "cashback": null,
            "currency": "USD",
            "id": "card_settlement_khv5kfeu0vndj291omg6",
            "interchange": {
              "amount": "0.137465",
              "code": "271",
              "currency": "USD"
            },
            "merchant_acceptor_id": "5665270011000168",
            "merchant_category_code": "5734",
            "merchant_city": "New York",
            "merchant_country": "US",
            "merchant_name": "AMAZON.COM",
            "merchant_postal_code": "10045",
            "merchant_state": "NY",
            "network": "visa",
            "network_identifiers": {
              "acquirer_business_id": "69650702",
              "acquirer_reference_number": "83163715445437604865089",
              "authorization_identification_response": "ABC123",
              "transaction_id": "627199945183184"
            },
            "pending_transaction_id": null,
            "presentment_amount": 100,
            "presentment_currency": "USD",
            "purchase_details": {
              "car_rental": null,
              "customer_reference_identifier": "51201",
              "fleet": null,
              "local_tax_amount": null,
              "local_tax_currency": "USD",
              "lodging": {
                "check_in_date": "2023-07-20",
                "daily_room_rate_amount": 1000,
                "daily_room_rate_currency": "USD",
                "extra_charges": "restaurant",
                "folio_cash_advances_amount": 0,
                "folio_cash_advances_currency": "USD",
                "food_beverage_charges_amount": 0,
                "food_beverage_charges_currency": "USD",
                "no_show_indicator": "no_show",
                "prepaid_expenses_amount": 0,
                "prepaid_expenses_currency": "USD",
                "room_nights": 1,
                "total_room_tax_amount": 100,
                "total_room_tax_currency": "USD",
                "total_tax_amount": 100,
                "total_tax_currency": "USD"
              },
              "national_tax_amount": null,
              "national_tax_currency": "USD",
              "purchase_identifier": "10203",
              "purchase_identifier_format": "order_number",
              "travel": null
            },
            "scheme_fees": [
              {
                "amount": "0.137465",
                "created_at": "2020-01-31T23:59:59Z",
                "currency": "USD",
                "fee_type": "visa_corporate_acceptance_fee",
                "fixed_component": null,
                "variable_rate": "0.0002"
              }
            ],
            "surcharge": null,
            "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
            "type": "card_settlement"
          },
          "category": "card_settlement",
          "created_at": "2020-01-31T23:59:59Z"
        }
      ],
      "id": "card_payment_nd3k2kacrqjli8482ave",
      "physical_card_id": null,
      "state": {
        "authorized_amount": 100,
        "fuel_confirmed_amount": 0,
        "incremented_amount": 20,
        "refund_authorized_amount": 0,
        "refunded_amount": 0,
        "reversed_amount": 20,
        "settled_amount": 100
      },
      "type": "card_payment"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes

    • warning

      added the new pulse_tokenization_fee enum value to the //////// response property for the response status

    • warning

      added the new pulse_tokenization_fee enum value to the //////// response property for the response status

    • warning

      added the new pulse_tokenization_fee enum value to the //////// response property for the response status

    • warning

      added the new pulse_tokenization_fee enum value to the //////// response property for the response status

    • warning

      added the new pulse_tokenization_fee enum value to the //////// response property for the response status

    • warning

      added the new pulse_tokenization_fee enum value to the //////// response property for the response status

    • warning

      added the new pulse_tokenization_fee enum value to the //////// response property for the response status

    • warning

      added the new pulse_tokenization_fee enum value to the //////// response property for the response status

    • warning

      added the new pulse_tokenization_fee enum value to the //////// response property for the response status

    • warning

      added the new pulse_tokenization_fee enum value to the //////// response property for the response status

    • warning

      added the new visa_recurrent_reference_identifier enum value to the ///////// response property for the response status

    • warning

      added the new visa_recurrent_reference_identifier enum value to the ///////// response property for the response status

    • info

      added the required property ////// to the response with the status