Introduction

We have a REST API which can accept receipt data one by one. Within the receipt object are details about the location, items purchased, as well as payment details.

API Accesss

Please reach out to your Banyan representative to receive an API Key to begin using the REST service.

Endpoint URL

https://api.banyan.com/v1/receipt

Example Body

'{
"receipt": {
"id": "24568970",
"consumer_token": "d448d0aa-4383-40ff-a222-4bca8d7d53d7",
"purchase_ts": "2021-09-03T11:48:02.745487434Z",
"merchant": {
"name": "ACME, LLC"
},
"store": {
"name": "ACME Supercenter #1525",
"phone_number": "1-888-558-7326",
"address": {
"address_line_one": "31937 Main St",
"city": "Red Bank",
"state": "NJ",
"country": "USA",
"postal_code": "07701"
}
},
"payment": {
"payment_type": "credit",
"scheme": "mastercard",
"card_last_four": "2939",
"auth_code": "315004",
"arn": "30214080089",
"total_amount": "148.37",
"currency": "USD"
},
"location_type": "in_store",
}
"items": [
{
"id": 551637388,
"upc": "076174942484",
"brand": "Stanley",
"description": "STANLEY 94-248 Homeowner's 65-Piece DIY Tool Kit Sets",
"category": "Tools & Home Improvement",
"price": "54.50",
"discount": "0.00",
"quantity": "1"
},
{
"id": 651723283,
"upc": "885911571142",
"brand": "DEWALT",
"description": "DeWALT Atomic 20V MAX ½ Brushless Hammer Drill/Driver",
"category": "Tools & Home Improvement",
"price": "71.99",
"discount": "0.00",
"quantity": "1"
},
{
"id": 563085323,
"upc": "028877531946",
"brand": "DEWALT",
"description": "DeWalt Black Oxide Drill Bit Set - 16 PC, 16.0 PIECE(S)",
"category": "Tools & Home Improvement",
"price": "18.11",
"discount": "0.00",
"quantity": "1"
}

Example Response

Error Handling

The receipt will be validated upon delivery, and if there is an error, we will report it in our request response


Did this page help you?