Skip to main content
Sign in

Upon Transaction updated

John Twomey
  • Updated

When a transaction is updated

EVENT transaction_updated

Parameters

Field Type Description
environment String

The environment you'll be connecting to, such as sandbox. 
locationToken String

Unique POS Location token provided by Doshii
id String

Unique number identifying the transaction
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
verifyData Object

An optional list of properties that make up a verification request from the payment provider. This information will only be transmitted to the POS via this event, it cannot be retrieved at a later date from the transaction. Will not be included in the event if not set.
  requires String[]

Specifies the names of the verification properties that need to be verified by the POS. The allowed values include: 'accountId', 'issueDate', 'expiryDate', 'authorisationCode' and 'imageUri'
  accountIdoptional String

Requests that the ID of the account be verified, this typically maps to the gift card number, voucher code, payId for NPP, etc
  issueDateoptional String

Requests that the issue date (e.g. gift card issue date, voucher issue date, etc) of the payment item be verified. Is returned inDateTime format.
  expiryDateoptional String

Requests that the expiry date (e.g. gift card expiry date, voucher expiry date, etc) of the payment item be verified. Is returned inDateTime format.
  authorisationCodeoptional String

Requests an authorisation code as part of the verification process. This could take the form of the secure pin code on the back of a gift card, or a passphrase required by venue staff.
  imageUrioptional String

An external URI linking to an image resource. This is typically used to support facial recognition or captcha style verification processes. The value of this field would typically be the URI of the linked image to be verified.
app Object

The details of the App updating the transaction.
  id Number

The ID of the App that performed the transaction update.
  name String

The name of the App that performed the transaction update.

Example

Event

{
    "type": "transaction_updated",
    "data": {
        "id": "1354",
        "orderId": "12345",
        "status": "pending",
        "posRef": "ABC123",
        "verifyData": {
            "requires": ["imageUri"],
            "imageUri": "https://payment.app/verification_image.png"
        },
        "app": {
            "id": 27,
            "name": "Payment App"
        },
        "uri": "https://sandbox.doshii.co/pos/v3/transactions/1354"
    }
}

 

Related articles

Comments

0 comments

Please sign in to leave a comment.