Retrieve all Transactions for an Order
GET ~/orders/:pos-id/transactions
Headers
Field | Type | Description |
---|---|---|
Authorization | String |
Bearer authentication token prefixed with |
Content-Type | String |
Request content type, must be 'application/json' |
vendor | String |
The POS vendor name retrieved from Doshii dashboard |
Parameters
Field | Type | Description |
---|---|---|
:doshii-id | String |
The POS id of the Order to retrieve Transactions for |
Response
Field | Type | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | String |
Unique number identifying this resource |
||||||||||||||
orderId | String |
Unique number identifying the order this relates to |
||||||||||||||
reference | String |
A free-text field for entering external identifiers eg: bank deposit reference no. |
||||||||||||||
invoice | String |
External identifiers eg: Invoice number or bank deposit reference no. |
||||||||||||||
method | String |
Describes the payment method used, e.g. cash, giftcard, crypto, visa, etc |
||||||||||||||
amount | String |
An integer for the number of cents to be paid |
||||||||||||||
tip | String |
An optional integer for the number of cents transferred as a tip (additional to amount) |
||||||||||||||
acceptLess | Boolean |
Whether the POS will accept less than the |
||||||||||||||
partnerInitiated | Boolean |
Whether the Transaction was initiated by the Partner |
||||||||||||||
version | String |
An obfuscated representation of the version |
||||||||||||||
surcounts | Object[] |
Array of Surcount objects. |
||||||||||||||
posId | String |
Id of the item in the POS. Providing this will allow the POS to correctly print and report sales. |
||||||||||||||
name | String |
Name of item. |
||||||||||||||
type | String |
Whether this is an 'absolute' or 'percentage' Surcount. |
||||||||||||||
description | String |
Description of item. |
||||||||||||||
amount | String |
The amount to surcharge/discount (positive/negative integer) |
||||||||||||||
value | String |
The value of the surcounts in cents. Accepts integer or string of integers. This value should be calculated if the Surcount is % based. |
||||||||||||||
updatedAt | String |
Date when the record is last updated |
||||||||||||||
createdAt | String |
Date when the record is created |
||||||||||||||
uri | String |
The object details url |
||||||||||||||
status | String |
The current payment status. See Status and the Transaction State Machine for more information.
|
||||||||||||||
rejectionCode | String |
The code for a rejection. More information can be found by a GET /rejection-codes. Will not return if not set. |
||||||||||||||
rejectionReason | String | The reason defined by the App or POS as to why the payment was cancelled or rejected. Will not return if not set. | ||||||||||||||
linkedTrxIds | String |
The linked transaction ids if this transaction is a refund |
||||||||||||||
createdByApp | String |
ID identifying the App that originally created this transaction. Will not return if not set. |
||||||||||||||
processedByApp | String |
ID identifying the App that is processing the transaction. Will not return if not set. |
||||||||||||||
posTerminalId | String |
A hashed ID of the POS terminal that is associated to this transaction. Will not return if not set. |
||||||||||||||
requestedAppId | String |
ID identifying the App that the POS has requested to process this transaction. Will not return if not set. |
Example
Response
[
{
"id":"123",
"orderId":"112",
"status":"pending",
"reference":null,
"invoice":null,
"amount":"1000",
"acceptLess":true,
"version":"eqf8HE3deq",
"partnerInitiated":false,
"updatedAt": "2016-08-18T04:58:38.485Z",
"createdAt": "2016-08-18T04:58:38.485Z",
"uri": "https://sandbox.doshii.co/pos/v3/transactions/123"
},
{
"id":"124",
"orderId":"112",
"status":"complete",
"reference":"23ad34-45623f-768",
"invoice":"INV2245",
"method":"mastercard",
"amount":"1000",
"acceptLess":false,
"version":"AJHBFjAKJFE3fnj33njj",
"partnerInitiated":true,
"processByApp":"6",
"updatedAt": "2016-08-18T04:58:38.485Z",
"createdAt": "2016-08-18T04:58:38.485Z",
"uri": "https://sandbox.doshii.co/pos/v3/transactions/124"
}
]
Comments
0 comments
Please sign in to leave a comment.