v4

OpenAPI 3.1.02026-08-012402353.8 MB

List Card Validations

get/card_validations

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 Validations 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 Validations 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 Validation 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": {
        "accepted_at": "2020-01-31T23:59:59Z",
        "authorization_identification_response": "ABCDEF",
        "card_verification_value2_result": null,
        "cardholder_first_name_result": null,
        "cardholder_full_name_result": null,
        "cardholder_last_name_result": null,
        "cardholder_middle_name_result": null,
        "cardholder_postal_code_result": null,
        "cardholder_street_address_result": null,
        "network_transaction_identifier": "841488484271872"
      },
      "account_id": "account_in71c4amph0vgo2qllky",
      "card_token_id": "outbound_card_token_zlt0ml6youq3q7vcdlg0",
      "cardholder_first_name": "Dee",
      "cardholder_last_name": "Hock",
      "cardholder_middle_name": "Ward",
      "cardholder_postal_code": "10045",
      "cardholder_street_address": "33 Liberty Street",
      "created_at": "2020-01-31T23:59:59Z",
      "created_by": {
        "category": "user",
        "user": {
          "email": "user@example.com"
        }
      },
      "decline": {
        "declined_at": "2020-01-31T23:59:59Z",
        "network_transaction_identifier": "841488484271872",
        "reason": "transaction_not_permitted_to_cardholder"
      },
      "id": "outbound_card_validation_qqlzagpc6v1x2gcdhe24",
      "idempotency_key": null,
      "merchant_category_code": "1234",
      "merchant_city_name": "New York",
      "merchant_name": "Acme Corp",
      "merchant_postal_code": "10045",
      "merchant_state": "NY",
      "route": "visa",
      "status": "pending_submission",
      "submission": {
        "retrieval_reference_number": "123456789012",
        "submitted_at": "2020-01-31T23:59:59Z",
        "trace_number": "123456"
      },
      "type": "card_validation"
    }
  ],
  "next_cursor": "v57w5d"
}