Retrieve a single Transaction.
GET ~/transactions/:transaction-id
Headers
Field | Type | Description |
---|---|---|
doshii-location-id | String |
The hashed ID of the location you're targeting. See Hashed Location IDs |
Parameters
Field | Type | Description |
---|---|---|
:transaction-id | String |
The ID of the transaction you'd like to retrieve |
Response
Field | Type | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | String |
Unique number identifying this resource |
||||||||||||||
orderId | String |
Unique number identifying the order this relates to. It is possible that this property may be 'null' indicating that the transaction has not yet been associated to an order. |
||||||||||||||
reference | String |
A free-text documentary field for misc. information |
||||||||||||||
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 |
||||||||||||||
prepaid | Boolean |
If the Transaction has already been performed. Doshii will respond on behalf of the Partner when the POS requests payment and will notify when complete or rejected. |
||||||||||||||
version | String |
An obfuscated representation of the version |
||||||||||||||
status | String |
The current payment status. See Status and the Order 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. | ||||||||||||||
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 |
||||||||||||||
linkedTrxId | String |
The linked transaction id 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. |
Examples
Response
{
"id":"125",
"orderId":"182",
"reference":"123-456-789",
"invoice":"INV22627",
"method":"visa",
"amount":"2250",
"tip":"250",
"acceptLess":false,
"partnerInitiated":true,
"prepaid":true,
"version":"nfw8w3DBK",
"status":"complete",
"createdByApp": "123",
"processedByApp": "123",
"updatedAt": "2016-08-18T04:58:38.485Z",
"createdAt": "2016-08-18T04:58:38.485Z",
"uri": "https://sandbox.doshii.co/partner/v3/transactions/125"
}
Comments
0 comments
Please sign in to leave a comment.