Ingenico ePayments provides you
wr files, which contain key information for payment reconciliation. These files are uploaded to a SFT-account.
This topic provides information about reading the file to implement a workflow to reconcile payments and handle charge backs.
Refer to wx1 files moving forward, as wr1 files have been deprecated.
.wr files include all payments, reversals, refunds, and chargebacks processed on behalf of the merchant's business and includes transactions from the day before the file was sent.
MERCHANTREFERENCENUMBER is a unique identifier of transactions. In the
.wr file, use the
MERCHANTREFERENCENUMBER to reconcile payments.
MERCHANTREFERENCENUMBER is mapped to different values, depending on whether the payment is a sale call or a refund call.
If you, as the merchant, pass the Zuora API field
Payment.GatewayOrderId, it will be mapped to the
If you do not pass
Payment.GatewayOrderId, Zuora will create a value by using the
PaymentNumber-TenantID and will map that to
To obtain the
PaymentNumber, you must remove the
TenantID information. Once you have retrieved the
PaymentNumber, you can search for the payment number within Zuora.
For example, if the payment number is
PN-00000023 and the tenant ID is
10, the format on the
.wr file is
The invoice number is mapped to the
PaymentNumber. The length of the Ingenico ePayments invoice number is limited to a maximum of 20 characters. Because the
PaymentNumber length is 10 characters and the Invoice number length is 12 characters, Ingenico ePayments will not accept the
PaymentNumber-InvoiceNumber combination. In this case, Zuora will map the invoice number to the
For Sale transactions, the integration uses a two-step process with the following Ingenico ePayments API calls:
Insert Order With Payment()+
SetPayment(). As part of the prerequisite for setting up the Ingenico ePayments Payment Gateway, your Ingenico ePayments account should be configured to support this two-step process.
For refund call, the integration use the
RefundNumber-TenantID to create a
Zuora also passes the Business Identification Code (BIC) for direct debit payments in Switzerland.
Zuora has implemented the one-step process for refunds and by default, your Ingenico ePayments account is set to use this one-step process. With the one-step process, Zuora will make a
DoRefund call, and Ingenico ePayments will process the refund automatically.
The following restrictions apply to the Zuora API information that is included in the
.wrfile will contain only the first 20 characters. Ingenico ePayments will accept a maximum of 20 characters for the PaymentNumber.