When a transaction is changed
EVENT transaction_updated
Parameters
Field | Type | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | 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.
|
||||||||||||||
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. |
||||||||||||||
verifyData | Object |
An optional list of verification data that respond to a verification request from the payment provider. This information will only be transmitted back to the payment provider via the event, it cannot be retrieved at a later date from the transaction. Will not be included in the event if not set. |
||||||||||||||
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. Will not be included in the event if not set. |
||||||||||||||
issueDate | String |
A |
||||||||||||||
expiryDate | String |
A |
||||||||||||||
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. Will not be included in the event if not set. |
||||||||||||||
imageUri | 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 same value sent by the payment provider to verify that the linked image was verified. Will not be included in the event if not set. |
Example
Event
{
"event": "transaction_updated",
"data": {
"id": "1354",
"orderId": "123",
"locationId": "aH43yx2",
"status": "complete",
"posRef": "o987684",
"posTerminalId": "23fd46",
"verifyData": {
"imageUri": "https://payment.app/verification_image.png"
}
"uri": "https://sandbox.doshii.co/partner/v3/transactions/1354"
}
}
Comments
0 comments
Please sign in to leave a comment.