Receipt Integration Guide

Introduction

The following document is designed to provide an overview of the best practices for receipt generation for eCommerce and Mail Order/Telephone Order (MOTO) transactions. The intention is to ensure that there is clarity on the brand requirements, federal law requirements, and recommended best practices.

Intended audience

This guide is intended for internal staff and eCommerce or web application developers to provide the elements that need to be present on receipts for all markets. This guide does not provide all technical or business requirements for development and payment acceptance. Instead, this guide is a tool for developers that provides receipt requirements for eCommerce applications in North America Marketplace.

Common Receipt Requirements

eCommerce application development vendors must incorporate certain receipt data elements but may modify the layout to be consistent with their current receipt layout (unless otherwise noted in these requirements). See the table below for the required fields across the different receipt types.

Retrieving required fields

For a transaction request example and how to retrieve these fields, please see Receipt Field Breakdowns and Retrieval.
Ensure you are properly authenticated with the Bambora service and create a payment transaction request using the REST API service. For more information on using the Bambora Payment API, see the developer documentation.

Conditionally required fields

The table below defines the fields that can be provided on a receipt under certain conditions

Optional fields

The table below defines the fields the optional receipt fields. Although not required, including the information below may reduce chargebacks in certain instances.

Standard Receipt Template

The template below represents the standard receipt for all transactions, with all possible fields allocated to their desired position on the receipt.

Receipt Field Breakdowns and Retrieval

Credit Sale (Purchase)

The Sale transaction, also sometimes referred to as Purchase transaction, is the most basic and most common transaction used for the purchase of goods or services. In a sale, the authorizing agent's system compares the cardholder's credit limit to the amount specified in the sale transaction. If the amount is available, the card issuer transmits an approval code. If the amount is not available, then a decline is received from the card issuer.
To receive the fields listed in the Section 1 tables above, see the transaction example below.

Example 1: Successful Payment

Request

Make a payment using credit card, cash, check, profile, token, Apple Pay or Google Pay. Each payment type has its own json definition passed in the body. For all payments you have the standard Billing, Shipping, Comments, etc. fields that are optional.

Request

{
    "order_number": "000011",
    "amount": 5.01,
    "payment_method": "card",
    "card": {
        "name": "Test User",
        "number": "4030000010001234",
        "expiry_month": "12",
        "expiry_year": "25",
        "cvd": 123
    },
    "shipping": {
        "name" : "Test User",
        "address_line1" : "123 Victoria St",
        "city" : "Victoria",
        "province" : "BC",
        "country" : "CA",
        "postal_code" : "30329",
        "phone_number" : "1-250-222-3333"
    },
     "billing": {
        "name" : "Test User",
        "address_line1" : "123 Victoria St",
        "city" : "Victoria",
        "province" : "BC",
        "country" : "CA",
        "postal_code" : "30329",
        "phone_number" : "1-250-222-3333"
    },
    "custom": {
        "ref1":"Test"
    }
}

Response

If successful, you should receive a payment response with the HTTP code 200: success. The response definition is returned as outlined below:

Response

{
    "id": "10001756",
    "authorizing_merchant_id": 353880000,
    "approved": "1",
    "message_id": "1",
    "message": "Approved",
    "auth_code": "TEST",
    "created": "2021-07-07T10:18:34",
    "order_number": "OrderNumberExample1234",
    "type": "P",
    "payment_method": "CC",
    "risk_score": 0.1,
    "amount": 99.99,
    "custom": {
        "ref1": "",
        "ref2": "",
        "ref3": "",
        "ref4": "",
        "ref5": ""
    },
    "card": {
        "card_type": "VI",
        "last_four": "1234",
        "address_match": 0,
        "postal_result": 0,
        "avs_result": "0",
        "cvd_result": "5",
        "eci": 7,
        "avs": {
            "id": "U",
            "message": "Address information is unavailable.",
            "processed": false
        }
    }
}

Glossary