List Card Push Transfers

Changed on
get/card_push_transfers

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/card_push_transfers
  • 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 Push Transfers to ones belonging to the specified Account.

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.

status.instring[]

Filter Card Push Transfers by status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Response

Card Push Transfer 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": [
    {
      "acceptance": null,
      "account_id": "account_in71c4amph0vgo2qllky",
      "approval": null,
      "business_application_identifier": "funds_disbursement",
      "cancellation": null,
      "card_token_id": "outbound_card_token_zlt0ml6youq3q7vcdlg0",
      "created_at": "2020-01-31T23:59:59Z",
      "created_by": {
        "category": "user",
        "user": {
          "email": "user@example.com"
        }
      },
      "decline": null,
      "id": "outbound_card_push_transfer_e0z9rdpamraczh4tvwye",
      "idempotency_key": null,
      "merchant_category_code": "1234",
      "merchant_city_name": "New York",
      "merchant_legal_business_name": null,
      "merchant_name": "Acme Corp",
      "merchant_name_prefix": "Acme",
      "merchant_postal_code": "10045",
      "merchant_state": "NY",
      "merchant_street_address": null,
      "presentment_amount": {
        "currency": "USD",
        "value": "12.34"
      },
      "recipient_address_city": null,
      "recipient_address_line1": null,
      "recipient_address_postal_code": null,
      "recipient_address_state": null,
      "recipient_name": "Ian Crease",
      "route": "visa",
      "sender_address_city": "New York",
      "sender_address_line1": "33 Liberty Street",
      "sender_address_postal_code": "10045",
      "sender_address_state": "NY",
      "sender_name": "Ian Crease",
      "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
      "status": "pending_submission",
      "submission": null,
      "type": "card_push_transfer"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes

  • 062c7be44217Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

  • df2b1ead4c49Revision changes
    • breaking

      for the query request parameter limit, default value 100 was added