Search…
Token Receipt API
This API is for Patners that are able to deliver card related token with receipt data.

Token Receipt API

Request

POST /api/v1/receipts/ HTTP/1.1
Host: api.dev.receipthero.io
Authorization: Token <RECEIPTHERO_API_KEY>
Content-Type: application/json
{
"attributes": {
"tokens": [
{
"type": "CARD",
"value": "bmxpbmUgSldMjksImV4cCI6MTY0NzcwNTIyOSwiYXVkIjoid3d3",
"id": "parter-token-xyz",
}
]
},
"receipt": <HEROJSON>
}

Token object

Key
Type
Description
Required
type
String
Token type: CARD|USER|PHONE|EMAIL|QR_CODE
value
String
Token value
id
String
Token identifier (Defined by the Partner)
Required if Token type = CARD
ReceiptHero JSON as <HeroJSON>

Response OK

HTTP 200 OK
Content-Type: application/json
Copy link
On this page
Token Receipt API
Request
Response OK