Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Fees

List dispute fees

Get a list of fees with filter and paging options.

get/v1/fee

Query parameters

beginDatestring

Beginning date filter, format = yyyy-mm-dd.

endDatestring

End date filter, format = yyyy-mm-dd.

claimIdstring

Fee item claim ID.

cardIdstring

Fee item card ID. Return dispute fees associated with a specific card.

networkFeeIdstring

Fee ID from network.

status'PENDING' | 'PROCESSED' | 'FAILED'
Example:PROCESSED

Status filter.

pageinteger

Page to return.

perPageinteger

Number of items per page.

Headers

x-tenantstring required

Organization/tenant ID. Get all dispute fees associated with an organization/tenant.

Response

OK

idnumber

Dispute fee ID

arnstring

Acquirer reference number. REQUIRED if claim_id is not passed.

transaction_amountnumber double

Transaction amount. REQUIRED if claim_id is not passed.

transaction_datestring date-time

Transaction date, format = yyyy-mm-dd hh:mm:ss. REQUIRED if claim_id is not passed.

card_idinteger

Enrolled card ID

card_acceptor_codestring

Merchant ID associated with this fee collection..if any.

country_codestring

ISO country code.

destination_memberstring

Destination member for the fee collection. These values are known to the network and identify either the acquirer or issuer.

fee_datestring date

Date the fee was attached to the claim, format = yyyy-mm-dd

currencystring

ISO 4217 currency code.

amountnumber double

Fee amount.

messagestring

Message regarding fee - 100 chars maximum.

reason_codestring

Collection reason code. These codes can be found in Mastercard's Global Clearing Management System Reference Manual starting on page 408.

settlement_datestring date

Settlement date, format = yyyy-mm-dd.

control_numberstring

Control number

credit_senderboolean

Credit the sender? Default is false.

credit_receiverboolean

Should receiver be credited?

network_brand_type'Visa' | 'Mastercard' | 'Elo'

Network brand

status'PENDING' | 'PROCESSED' | 'FAILED'

Dispute fee status - PENDING, PROCESSED, or FAILED.

chargeback_ref_numstring

Chargeback reference number

reconciliation_amountnumber double

Reconciliation amount

reconciliation_currencystring

Reconciliation currency

japan_common_merchant_codestring

Japanese common merchant codes

installment_datastring

Installment data

reply_fee_idstring

Fee ID to send to reply to created fee.

reject_reasonstring

Reject reason

created_atstring

When dispute created, format = yyyy-mm-ddThh:mm:ss"

updated_atstring date-time

Datetime program calendar strategy was updated. Format = YYYY-MM-DDTHH:MM:SS:MM

created_at_utcstring date-time

Dispute created in UTC date/time.

updated_at_utcstring

When dispute updated in UTC date/time.

Example response

[
  {
    "id": 152,
    "arn": "1564984",
    "transaction_date": "2022-06-01 10:25:36",
    "card_id": 6743052,
    "card_acceptor_code": "Test1234",
    "country_code": "USA",
    "destination_member": "002083",
    "fee_date": "2021-02-15",
    "currency": "USD",
    "amount": 100,
    "message": "Cardholder recognized transaction",
    "reason_code": "7604",
    "settlement_date": "2021-09-22",
    "control_number": "1589457",
    "network_brand_type": "Visa",
    "status": "PENDING",
    "chargeback_ref_num": "9000000006",
    "reconciliation_amount": 123.22,
    "reconciliation_currency": "EUR",
    "japan_common_merchant_code": "0410",
    "installment_data": "1234567890",
    "reply_fee_id": "300009520876",
    "reject_reason": "Code1=0142(00):D0063/002;DE072=D0063\\\\\\\\\\\\\\\\8000000808\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ ",
    "created_at": "2222-10-07T11:21:45",
    "updated_at": "2024-09-12T16:46:16.43663522",
    "created_at_utc": "2021-02-21T22:51:43.000000000Z",
    "updated_at_utc": "2022-10-13T19:56:010000000Z"
  }
]