Notifications

By implementing a webhook endpoints according to this specification, Card Issuers can receive notifications on Receipt and Card related events.

Receipt

When a Receipt has been processed for a Card, a request is sent to the webhook implemented by a ReceiptHero partner. Receipt Identifier (receipt_id) can then be used to fetch the Receipt in various data formats, as specified here.

POST: <PARTNER_URL_HERE>
Authorization: <PARTNER_API_KEY_HERE>
Host: <PARTNER_HOST_HERE>

{
  "notification_type":"receipt_notification",
  "partner_card_id":"58907e9a-af14-4127-bc72-7a2f867b6252",
  "receipthero_card_id":"2f253eeb-1fd8-4725-af8f-f5cd2223fac3",
  "data": {
    "receipt_id": "bdb8fe66-eced-416c-ace8-c81524f68ed4",
    "merchant_name": "Coffee Shop Developer Fuel Inc",
    "timestamp":"2021-08-09T10:00:48Z",
    "amount":"1230",
    "merchant_id":"1245357457",
    "reference_number":"y4MvVQva2XW1B8Qr",
    "authorization_code":"A145G6",
    "transaction_type":"auth"
  }
}
FieldDescriptionRequired

notification_type

Notification type

partner_card_id

External card indentifier provided by the partner

receipthero_card_id

ReceiptHero card identifier

receipt_id

ReceiptHero Receipt identifier

merchant_name

Name of the merchant

timestamp

Timestamp of the Card payment associated with the Receipt

amount

Amount of the Card payment associated with the Receipt

merchant_id

Merchant identifier

reference_number

Reference number of the Card payment associated with the Receipt

authorization_code

Authorization code of the Card payment associated with the Receipt

transaction_type

Type of Transaction (auth|clearing)

Card Added

This event is published once a new Card has been successfully processed by ReceiptHero.

POST: <PARTNER_URL_HERE>
Authorization: <PARTNER_API_KEY_HERE>
Host: <PARTNER_HOST_HERE>

{
  "notification_type": "card_added",
  "partner_card_id": "58907e9a-af14-4127-bc72-7a2f867b6252",
  "receipthero_card_id": "2f253eeb-1fd8-4725-af8f-f5cd2223fac3",
  "data": {
    "name": "John Doe",
    "masked_pan": "411111******1111",
    "exp_date": "2024-01-31T00:00:00.000Z"
  }
}

FieldDescriptionRequired

notification_type

Notification type (card_added)

partner_card_id

External card indentifier provided by the partner

receipthero_card_id

ReceiptHero card identifier

name

Card holder name

masked_pan

Masked card number

exp_date

Card expiration date

Last updated