Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Disputes

List Disputes

Retrieve a list of Dispute resources.

get/disputes

Query parameters

adjustment_transfer_idstring

Filter by the ID of the adjustment Transfer. <br><br>Note: If included, all other filter parameters are ignored.

application_idstring
Example:APc9vhYcPsRuTSpKD9KpMtPe

Filter by Application ID.

amountinteger
Example:100

Filter by an amount equal to the given value.

amount.gtinteger
Example:100

Filter by an amount greater than.

amount.gteinteger
Example:100

Filter by an amount greater than or equal.

amount.ltinteger
Example:100

Filter by an amount less than.

amount.lteinteger
Example:100

Filter by an amount less than or equal.

after_cursorstring

Return every resource created after the cursor value.

before_cursorstring

Return every resource created before the cursor value.

created_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where created_at is after the given date.

created_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where created_at is before the given date.

buyer_identity_first_namestring

Filter by buyer's first name.

buyer_identity_last_namestring

Filter by buyer's last name.

buyer_business_namestring

Filter by the business_name of the buyer's Identity.

buyer_doing_business_asstring

Filter by the doing_business_as of the buyer's Identity.

instrument_binstring

Filter by the Bank Identification Number (BIN). The BIN is the first 6 digits of the masked account number.

instrument_brand_typestring

Filter by the card brand used.

instrument_card_last4string

Filter by the last 4 digits of the card used.

instrument_card_typestring

Filter by the card type.

instrument_fingerprintstring

Filter by the fingerprint of the Payment Instrument.

instrument_namestring

Filter by the name of the Payment Instrument.

instrument_typestring

Filter by Payment Instrument type.

limitinteger
Example:10

The numbers of items to return.

merchant_identity_idstring

Filter by the ID of the Identity used by the Merchant.

merchant_identity_namestring

Filter by the name used by the Merchant.

merchant_identity_name.likestring

Filter by the name used by the Merchant. Use this when searching with only partial name values.

merchant_idstring

Filter by the ID of the Merchant.

merchant_midstring

Filter by the MID of the Merchant.

namesstring

Filter by the name used by the Merchant, the buyer's first and last name, business_name, and doing_business_as used by Identities when role is BUYER.

names.likestring

Filter by the name used by the Merchant, the buyer's first and last name, business_name, and doing_business_as used by Identities when role is BUYER. Use this when searching with only partial values.

response_statestring

Filter by the response_state of the Dispute.

respond_by.ltestring

Filter where respond_by is before the given date.

respond_by.gtestring

Filter where respond_by is after the given date.

tagsstring

Filter by the key or value of tags.

tags.likestring

Filter by the key or value of tags. Use this when searching with only partial values.

tags.keystring
Example:card_type

Filter by the tag's key. For more information, see Tags.

tags.valuestring
Example:business_card

Filter by the tag's value. For more information, see Tags.

transfer_idstring

Filter by the ID of the Transfer that's being disputed. <br><br>Note: If included, all other filter parameters are ignored.

statestring

Filter by the state of the Dispute.

updated_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where updated_at is after the given date.

updated_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where updated_at is before the given date.

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

List of Dispute resources

Example response

{
  "_embedded": {
    "disputes": [
      {
        "transfer": "TRxxxxxxxxxxxxxxxxxx"
      }
    ]
  }
}