Get data of retrievals

Get data of retrievals
  • Retrieval information request description and example
  • Method: POST , URL /retrieval
  • 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": null,
  "merchant_id": "3401602",
  "parent_merchant_id": null,
  "acq_ref_nrs": [ "MWMy5zITi3hHheCnG3GPJ8i" ],
  "transaction_ids": null,
  "payment_order_nrs": null,
  "file_date_from": "2017-11-10",
  "file_date_to": "2017-11-10",
  "page": 0,
  "per_page": 10,
  "sortKey": null,
  "sortOrder": null
}
          
Retrieval 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.rr_proc_date
Chargeback scheme processing date, format YYYY-MM-DD
Card schemes use date as reference period for calculating allowed timeframe for representments.
content.acq_bin Acquirer bank identification code – MC ICA or Visa BIN
content.rr_refer_num Retrieval request reference number as provided by issuer
content.card_type Card Scheme “VISA” or “MC”
content.parent_mrch_id Parent merchant id (if two level merchant hierarchy used)
content.parent_mrch_name Parent merchant name
content.mcc_code Merchant category code
content.eci_sli Electronic Commerce Indicator (for VISA cards) Security Level Indicator (for MasterCard cards)
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
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
content.rev_date_time Reversal date present only if original Transaction was reversed YYYY-MM-DD HH24:MM:SS
content.payment_id Payment identification code – unique identified used to identify payments in PGW interface.
content.xid Transaction Identifier
content.merchant_response Used by merchant to communicate the decision to FD with regards to chargeback acceptance.
“Doc provided”,
“Doc Not provided”
content.merchant_resp_date Merchant response date YYYY-MM-DD
content.merchant_comments Additional merchant comments in support of decision.
content.merchant_iban_code Merchant bank account number
content.fdl_comments Additional merchant comments in support of decision.
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 Related invoice order_id
Pagination information
totalPages Total number of pages for selection done with current "page" and "per_page" in request
totalElements Total number of retrievals matching the request parameters.
Example response
{
  "content":  [
    {
      "bank_id": "29",
      "file_date": "2017-11-10",
      "card": null,
      "acq_ref_nr": "MWMy5zITi3hHheCnG3GPJ8i",
      "merchant_id": "3401602",
      "merchant_name": null,
      "reason_code": 0,
      "rr_proc_date": null,
      "acq_bin": null,
      "rr_refer_num": null,
      "card_type": null,
      "parent_mrch_id": "np9CIPERGqfpAej",
      "parent_mrch_name": null,
      "mcc_code": null,
      "eci_sli": null,
      "tr_amount": null,
      "tr_ccy": null,
      "tr_date_time": null,
      "rev_amount": null,
      "rev_ccy": null,
      "rev_date_time": null,
      "payment_id": "TEST_SHOP",
      "xid": null,
      "merchant_response": "Doc Not provided",
      "merchant_resp_date": null,
      "merchant_comments": null,
      "merchant_iban_code": null,
      "fdl_comments": null,
      "transaction_id": "eGeBtjbkRbBXyHS",
      "card_acceptor_id": null,
      "payment_order_nr": "10ZpHuVMloIWaEnSxvk4"
    }
  ],
  "totalPages": 1,
  "totalElements": 1
}