Skip to content

docs: add transaction descriptor #316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pevidex merged 2 commits into from
Aug 4, 2026
Merged

docs: add transaction descriptor #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33c8ab1
docs: add transaction descriptor
pevidex Aug 4, 2026
e813f99
docs: add descriptors to webhook examples
pevidex Aug 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions select/transactions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ One transaction event occurs at authorisation time. The other transaction event
| `created` | The time when the transaction object was created in the Fidel API database. | string, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format |
| `currency` | The currency of the purchase. | string, alpha code format of [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) |
| `datetime` | The time of the transaction (local time of the merchant). | string, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format |
| `descriptor` | The merchant and store descriptor information provided by the card network. | object |
| `descriptor.merchantName` | The merchant name provided by the card network. | string (or null) |
| `descriptor.storeName` | The store name provided by the card network. | string (or null) |
| `id` | The unique identifier of the transaction. | string |
| `identifiers` | See the definition of the identifiers object below. | object |
| `location.address` | The street address of the location where the purchase was made. | string |
Expand Down Expand Up @@ -73,6 +76,10 @@ fileName:transaction.json
"created": "2019-04-09T16:00:00.644Z",
"currency": "GBP",
"datetime": "2019-04-10T15:59:30",
"descriptor": {
"merchantName": "Coffee Brand London",
"storeName": "Coffee Brand"
},
"programId": "6e38aa0c-b7ef-46bd-b1bd-c07c647d9cba",
"refundTransactionId": null,
"updated": "2019-04-09T16:00:00.644Z",
Expand Down
16 changes: 16 additions & 0 deletions select/webhooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,10 @@ fileName:transaction.auth
"cleared": false,
"amount": 100,
"currency": "GBP",
"descriptor": {
"merchantName": "Bob's Cafe London",
"storeName": "Bob's Cafe"
},
"wallet": null,
"card": {
"id": "bc538b71-31c5-4699-840a-6d4a08693314",
Expand Down Expand Up @@ -363,6 +367,10 @@ fileName:transaction.clearing
"updated": "2020-07-08T17:20:44.134Z",
"programId": "06471dbe-a3c7-429e-8a18-16dc97e5cf35",
"datetime": "2020-07-08T18:05:52",
"descriptor": {
"merchantName": "Bob's Cafe Bristol",
"storeName": "Bob's Cafe"
},
"card": {
"id": "62744670-f935-4ba3-8e89-be23e31292cf",
"firstNumbers": "444400",
Expand Down Expand Up @@ -406,6 +414,10 @@ fileName:transaction.refund
"authCode": "A73H890",
"originalTransactionId": "8bbbf56b-3819-473b-877d-cf2175f268f4",
"currency": "GBP",
"descriptor": {
"merchantName": "Bob's Cafe Bristol",
"storeName": "Bob's Cafe"
},
"id": "5ec08ca8-38c6-42e1-9fa5-32c67e4135b2",
"amount": -10,
"wallet": null,
Expand Down Expand Up @@ -491,6 +503,10 @@ This means that partial refunds will not be identified as the cashback amount is
"auth": false,
"authCode": "A73H890",
"currency": "GBP",
"descriptor": {
"merchantName": "Bob's Cafe Bristol",
"storeName": "Bob's Cafe"
},
"id": "5ec08ca8-38c6-42e1-9fa5-32c67e4135b2",
"amount": -10,
"wallet": null,
Expand Down
Loading