Get data of chargebacks

Get data of chargebacks
  • Chargeback information request description and example
  • Method: POST , URL /chargeback
  • Fields for signature calculation: <X-Nonce><ShopPassword>
Field Usage Description
file_date_from optional Starting date for files to return in response in “YYYY-MM-DD” format
file_date_to optional End date for files to return in response in “YYYY-MM-DD” format
shop_codes optional Array list of shopcodes
merchant_id optional Merchant identification number(MID)
parent_merchant_id optional Parent merchant id(MID), if two level merchant hierarchy used
acq_ref_nrs optional Transaction “Acquirer reference number”
transaction_ids optional Array list of unique numbers given by the Network to identify a Cardmember Transaction throughout its life cycle
payment_order_nrs optional Array list of unique order ID/bill number in the merchant system
page optional Page number of results, starting with 0. Default value is 0.
per_page optional Number of chargebacks per page, as value between 10 and 1000. Default value is 10.
sortKey optional Parameter to sort by, possible values:
ID
SHOP_CODE
MERCHANT_ID
ACQ_REF_NR
PAYMENT_ORDER_NR
FILE_DATE
sortOrder optional Sorting order for sortKey argument, possible values "asc" or "desc", default is "asc" (ascending).
Request example
{
  "shop_codes": [ "TEST_SHOP" ],
  "merchant_id": null,
  "parent_merchant_id": null,
  "acq_ref_nrs": null,
  "transaction_ids": [ "b6eVMJNyE5rbjOx", "jOu63lZkdHeGnsb", "KiGMsN7gbuxm52J" ],
  "payment_order_nrs": [ "MaCcP3iNawa5OM3YGBCe", "CYkckbyqXbEeAhON17Pl", "Vzmjbj3YFedEuPnmOtqH" ],
  "file_date_from": "2017-11-10",
  "file_date_to": "2017-11-10",
  "page": 0,
  "per_page": 10,
  "sortKey": "PAYMENT_ORDER_NR",
  "sortOrder": null
}
          
Chargeback information response description and example
Field Description
List of content as array
content.bank_id Constant bank ID value for Bilderling = 29
content.file_date Report file timestamp(date), following YYYY-MM-DD format
content.card Masked PAN (mask template 123456%1234)
content.acq_ref_nr Transaction “Acquirer reference number”
content.merchant_id Merchant identification number(MID)
content.merchant_name Merchant description (ISO8583 field 43)
content.reason_code
4 digit chargeback reason code according to MC scheme rules, or
2 digit chargeback reason code according to VISA scheme rules
content.parent_mrch_id Parent merchant id(MID), if two level merchant hierarchy used
content.parent_mrch_name Parent merchant name, if two level merchant hierarchy used
content.mcc_code Merchant category code
content.eci_sli Electronic Commerce Indicator (for VISA cards) Security Level Indicator (for MasterCard cards)
content.doc_indicator
Indicator of chargeback support documentation
‘0’ or ‘ ‘ – no documentation provided
‘1’ supporting documentation provided by issuer.
In case of ‘1’ PSP shall retrieve supporting documents from FD FTP.
Please note that documents may arrive up to 8 calendard days after chargeback scheme processing date according to scheme rules.
content.chb_proc_date
Chargeback scheme processing date, format YYYY-MM-DD
Card schemes use date as reference period for calculating allowed timeframe for representments.
content.comments Message provided by issuer bank
content.function_code
450 First Chargeback (Full)
451 Arbitration Chargeback (Full)
453 First Chargeback (Partial)
454 Arbitration Chargeback (Partial)
“Arbirtration chargeback” is also known as “2nd Chargeback”.
Codes 451 and 454 are in use for MC only.
Visa uses partial chargeback identifier for US members only, therefore Visa partial chargebacks may not be correctly recognized here.
content.function_code_name Textual description of Function code (element 13)
content.rev_indicator
Null or space filled for normal chargebacks and ‘R’ for chargeback reversals.
For chargeback reversals all data fields which refer to chargeback information (e.g. chb_settl_amount, Chb_proc_date) display data for chargeback reversal.
Chargeback reversal is credit to acquirer.
content.acq_bin Acquirer bank identification code – MC ICA or Visa BIN
content.chb_refer_num Chargeback reference number as provided by issuer
content.card_type Card Scheme “VISA” or “MC”
content.chb_tr_date Transaction date, format YYYY-MM-DD from chargeback data. May be zero filled if not provided by issuer.
content.chb_amount Chargeback amount in chargeback currency, format - point as decimal sign and 2 decimals. Left padded with spaces.
content.chb_ccy
Chargeback currency code (alpha)
For MasterCard chargebacks this is USD or original Transaction currency
For Visa chargebacks this is issuer billing currency
content.chb_settl_amount Chargeback amount in acquirer bank scheme settlement currency, format- point as decimal sign and 2 decimals. Left padded with spaces.
content.chb_settl_ccy Acquirer bank scheme settlement currency (alpha)
content.chb_amount_transaction_ccy
Chargeback amount in original Transaction currency (i.e.), format- point as decimal sign and 2 decimals. Left padded with spaces.
Chargeback settlement amount converted into Transaction currency using chargeback processing date scheme currency conversion rate table.
May not match original Transaction amount, because three conversions are involved – transaction converted by issuer into issuer currency, then converted by scheme into acquirer settlement currency and finally by First Data back into merchant currency.
For partial chargebacks this reflects partial amount charged back.
content.tr_amount Original Transaction amount (as originally processed by merchant), format- point as decimal sign and 2 decimals. Left padded with spaces.
content.tr_ccy Transaction amount currency code (alpha)
content.tr_date_time Transaction date YYYY-MM-DD HH24:MM:SS
content.rev_amount Reversal amount - present only if original Transaction was reversed, format- point as decimal sign and 2 decimals. Left padded with spaces.
content.rev_ccy Reversal amount currency code - present only if original Transaction was reversed (alpha)
content.rev_date_time Reversal date YYYY-MM-DD HH24:MM:SS - present only if original Transaction was reversed
content.payment_id Payment identification code – unique identified used to identify payments in PGW interface.
content.xid Transaction Identifier
content.merchant_decision
Null in files sent from FD. Used by merchant to communicate the decision to FD with regards to chargeback acceptance.
“Accept CB”,
“Represent doc provided”,
“Represent CR processed”
content.merchant_resp_date Null in files sent from FD. Merchant response date “YYYY-MM-DD”
content.merchant_comments Null in files sent from FD. Additional merchant comments in support of decision.
content.merchant_iban_code Merchant bank account number
content.transaction_id A unique number given by the Network to identify a Cardmember Transaction throughout its life cycle
content.card_acceptor_id The Service Establishment (S/E) number assigned by AmericanExpress
content.payment_order_nr Unique order ID/bill number in the merchant system (max 30 symbols)
Pagination information
totalPages Total number of pages for selection done with current "page" and "per_page" in request
totalElements Total number of chargebacks matching the request parameters.
Example response
{
  "content": [
    {
      "bank_id": "29",
      "file_date": "2017-10-30",
      "card": "541333%0027",
      "acq_ref_nr": "75400786042012818533333",
      "merchant_id": "3401602",
      "merchant_name": "Ea",
      "reason_code": 4863,
      "parent_mrch_id": "3401615",
      "parent_mrch_name": "Bilderlings Pay SIA",
      "mcc_code": "5499",
      "eci_sli": "910",
      "doc_indicator": 0,
      "chb_proc_date": "2017-10-30",
      "comments": null,
      "function_code": 450,
      "function_code_name": "First Chargeback (Full)",
      "rev_indicator": null,
      "acq_bin": "00000009090",
      "chb_refer_num": "9909806323",
      "card_type": "MC",
      "chb_tr_date": "2017-10-30",
      "chb_amount": 88.05,
      "chb_ccy": "USD",
      "chb_settl_amount": 88.05,
      "chb_settl_ccy": "USD",
      "chb_amount_transaction_ccy": 66.77,
      "tr_amount": 66.77,
      "tr_ccy": "EUR",
      "tr_date_time": "2017-10-30 00:01:07",
      "rev_amount": null,
      "rev_ccy": null,
      "rev_date_time": null,
      "payment_id": "21154864",
      "xid": null,
      "merchant_decision": "rebuttal",
      "merchant_resp_date": "2017-11-06",
      "merchant_comments": "Comment is here about 3333",
      "merchant_iban_code": "LV11CBKN1K23830111111",
      "transaction_id": null,
      "card_acceptor_id": null,
      "payment_order_nr": "order-1633"
    }
  ],
  "totalPages": 1,
  "totalElements": 1
}