Upon Transaction created – Doshii Guide

When a new transaction is created

EVENT transaction_created

Parameters

Field Type Description

String

Unique number identifying the transaction

locationId

String

Unique hashed id for this Location. See Hashed Location IDs

orderId

String

Unique number identifying the order this relates to

posRef

String

The POS reference for the order.

status

String

The current payment status. See Status for more information.

status	description
requested	POS has requested that a Partner process the transaction
pending	Partner signals intention to perform a Transaction
waiting	POS is waiting for the Partner to complete the Transaction
cancelled	Partner has terminated the Transaction
rejected	POS has terminated the Transaction
complete	The POS or Partner has completed the Transaction

uri

String

The transaction details url

posTerminalId

String

A hashed ID of the POS terminal that is associated to this transaction. Will not return if not set.

requestData

Object

An optional list of properties that support the payment request. Will not be included in the event if not set. This information will only be available via the event, it cannot be retrieved at a later date from the transaction.

accountId

String

Specifies the ID of the account to be used, this typically maps to the gift card number, voucher code, payId for NPP, etc

issueDate

String

A DateTime indicating when the payment item was issued (e.g. gift card issue date, voucher issue date, etc).

expiryDate

String

A DateTime indicating when the payment item expires (e.g. gift card expiry date, voucher expiry date, etc).

authorisationCode

String

The code used to authorise the request. This could take the form of the secure pin code on the back of a gift card, or a passphrase required by venue staff.

Example

Event

{
    "event": "transaction_created",
    "data": {
        "id": "1354",
        "orderId": "123",
        "locationId": "aH43yx2",
        "status": "requested",
        "posRef": "o987684",
        "posTerminalId": "23fd46",
        "requestData": {
            "accountId": "HwgD78834234Ds2d",
            "expiryDate": "2018-09-12T00:00:00.000Z"
        },
        "uri": "https://sandbox.doshii.co/partner/v3/transactions/1354"
    }
}

Parameters

Example

Event

Related articles