Custom Receipts
Should you need more flexibility than the ready-made receipts provide, you can send or print custom receipts, including the payment-related data.
Make sure that your custom receipt contains all of the required receipt information and that you are able to also send receipts for successful refunds.
Required Receipt information
A sample receipt with the required information and its placement is shown below. Actual receipt content can vary, depending on acquirer and payment method.
- Full address of the merchant, including the country. Iterate overmerchantDetails, for each line item printvalue.
- receiptType.value
- transactionType.value
- amountAndCurrency.value
- The payment details, e.g. the masked account number. Iterate overpaymentDetails, for each line item print thelabelandvalue.
- statusText.value
- date.valueandtime.value
- The clearing details, e.g. the merchant identifier. Iterate overclearingDetails, for each line item print thelabelandvalue.
- IfprintTipLineis true, then you have to print Tip and Total Amount lines on your receipts.
- IfprintSignatureLineis true, then you have to print a signature line on your merchant receipt.
Accessing Receipt Data
The receipts are already embedded in the transaction reference that you receive after a successful transaction. The transaction object provides access to the receipt for both, the merchant and the customer.
Receipts are only attached if the transaction did not fail, so always make sure to check the transaction and both receipt properties before accessing them.
How to access receipt data:
MPTransactionProcess *process = [transactionProvider startTransactionWithParameters:transactionParameters accessoryParameters:accessoryParameters registered:[...] statusChanged:[...] actionRequired:[...] completed:^(MPTransactionProcess *process, MPTransaction *transaction, MPTransactionProcessDetails *details) { MPReceipt *receipt = transaction.merchantReceipt; // For the Customer Receipt //MPReceipt *receipt = transaction.customerReceipt; NSLog(@"MERCHANT DETAILS"); for (MPReceiptLineItem* lineItem in receipt.merchantDetails) { NSString *label = lineItem.label; NSString *value = lineItem.value; NSLog(@"%@: %@", label, value); } NSLog(@" "); NSLog(@"%@: %@", receipt.receiptType.label, receipt.receiptType.value); NSLog(@"%@: %@", receipt.transactionType.label, receipt.transactionType.value); NSLog(@"%@: %@", receipt.amountAndCurrency.label, receipt.amountAndCurrency.value); NSLog(@" "); NSLog(@"PAYMENT DETAILS"); for (MPReceiptLineItem* lineItem in receipt.paymentDetails) { NSString *label = lineItem.label; NSString *value = lineItem.value; NSLog(@"%@: %@", label, value); } NSLog(@" "); NSLog(@"%@: %@", receipt.statusText.label, receipt.statusText.value); NSLog(@"%@: %@", receipt.date.label, receipt.date.value); NSLog(@"%@: %@", receipt.time.label, receipt.time.value); NSLog(@" "); NSLog(@"CLEARING DETAILS"); for (MPReceiptLineItem* lineItem in receipt.clearingDetails) { NSString *label = lineItem.label; NSString *value = lineItem.value; NSLog(@"%@: %@", label, value); } NSLog(@" "); // --- Optional NSLog(@"%@: %@", receipt.identifier.label, receipt.identifier.value); // --- // When offering Tip Adjust if(receipt.printTipLine) { NSLog(@"TIP : ___________________"); NSLog(@"TOTAL : ___________________"); } // --- Only for the Merchant Receipt if(receipt.printSignatureLine) { NSLog(@"Customer Signature:"); NSLog(@"___________________"); }
Custom Receipts
Should you need more flexibility than the ready-made receipts provide, you can send or print custom receipts, including the payment-related data.
Make sure that your custom receipt contains all of the required receipt information and that you are able to also send receipts for successful refunds.
Required Receipt information
A sample receipt with the required information and its placement is shown below. Actual receipt content can vary, depending on acquirer and payment method.
- Full address of the merchant, including the country. Iterate over each line itemgetMerchantDetails()returns and print what thegetValue()method returns.
- getReceiptType().getValue()
- getTransactionType().getValue()
- getAmountAndCurrency().getValue()
- The payment details, e.g. the masked account number. Iterate over each line itemgetPaymentDetails()returns and print what thegetLabel()andgetValue()methods return.
- getStatusText().getValue()
- getDate().getValue()andgetTime().getValue()
- The clearing details, e.g. the merchant identifier. Iterate over each line itemgetClearingDetails()returns and print what thegetLabel()andgetValue()methods return.
- IfisTipLineRequired()is true, then you have to print Tip and Total Amount lines on your receipts.
- IfisSignatureLineRequired()is true, then you have to print a signature line on your merchant receipt.
Accessing Receipt Data
The receipts are already embedded in the transaction reference that you receive after a successful transaction. The transaction object provides access to the receipt for both, the merchant and the customer.
Receipts are only attached if the transaction did not fail, so always make sure to check the transaction and both receipt properties before accessing them.
Here is how to access receipt data:
TransactionProcess paymentProcess = transactionProvider.startTransaction(transactionParameters, accessoryParameters, new TransactionProcessWithRegistrationListener() { @Override public void onCompleted(TransactionProcess process, Transaction transaction, TransactionProcessDetails processDetails) { // For the Merchant Receipt Receipt receipt = transaction.getMerchantReceipt(); // For the Customer Receipt // Receipt receipt = transaction.getCustomerReceipt(); Log.d("RECEIPT", "MERCHANT DETAILS"); for (ReceiptLineItem lineItem : receipt.getMerchantDetails()) Log.d("RECEIPT", lineItem.getLabel() + ": " + lineItem.getValue()); Log.d("RECEIPT", " "); Log.d("RECEIPT", receipt.getReceiptType().getLabel() + ": " + receipt.getReceiptType().getValue()); Log.d("RECEIPT", receipt.getTransactionType().getLabel() + ": " + receipt.getTransactionType().getValue()); Log.d("RECEIPT", receipt.getAmountAndCurrency().getLabel() + ": " + receipt.getAmountAndCurrency().getValue()); Log.d("RECEIPT", " "); Log.d("RECEIPT", "PAYMENT DETAILS"); for (ReceiptLineItem lineItem : receipt.getPaymentDetails()) Log.d("RECEIPT", lineItem.getLabel() + ": " + lineItem.getValue()); Log.d("RECEIPT", " "); Log.d("RECEIPT", receipt.getStatusText().getLabel() + ": " + receipt.getStatusText().getValue()); Log.d("RECEIPT", receipt.getDate().getLabel() + ": " + receipt.getDate().getValue()); Log.d("RECEIPT", receipt.getTime().getLabel() + ": " + receipt.getTime().getValue()); Log.d("RECEIPT", " "); Log.d("RECEIPT", "CLEARING DETAILS"); for (ReceiptLineItem lineItem : receipt.getClearingDetails()) Log.d("RECEIPT", lineItem.getLabel() + ": " + lineItem.getValue()); Log.d("RECEIPT", " "); // --- Optional Log.d("RECEIPT", receipt.getIdentifier().getLabel() + ": " + receipt.getIdentifier().getValue()); // --- // When offering Tip Adjust if(receipt.isTipLineRequired()) { Log.d("RECEIPT", "TIP : ___________________"); Log.d("RECEIPT", "TOTAL : ___________________"); } // --- Only for the Merchant Receipt if(receipt.isSignatureLineRequired()) { Log.d("RECEIPT", "Customer Signature"); Log.d("RECEIPT", "___________________"); } } } );