Querying transactions

It is possible to query a specific transaction in order to obtain detailed information about it. This is useful when receiving Paybyrd webhook or a technical issue prevent your software from receiving a payment response. Without this response your store staff may be unable to verify whether the transaction has been processed, or its result. They may also attempt to cancel or refund the transaction, or risk a duplicate transaction.

Query a transaction

You can find below an example of how to query a transaction and the response obtained:

curl --request GET \
  --url https://gateway.paybyrd.com/api/v2/transactions/{transactionId} \
  --header 'Accept: application/json'
  --header 'x-api-key: 07005f74-c87e-11eb-b8bc-0242ac130003' \
{
   "referencedTransactions":[],
   "code":"BYRD200",
   "description":"Operation successfully completed",
   "currency":"EUR",
   "orderRef":"ORDER#3570",
   "brand":"VISA",
   "operationType":"Payment",
   "status":"Success",
   "fingerPrint":"fb1714e5-f2a4-40c8-b3e6-7487187bdaab",
   "createdDate":"2021-06-08T22:07:37Z",
   "transactionDate":"2021-06-08T22:07:37Z",
   "capturedDate":"2021-06-08T22:08:06Z",
   "maskedCardNumber":"420000******0000",
   "initiatedFrom":"HostedForm",
   "subscriptionGuid":"476f8d2c-22ee-42a0-b986-0d01b9292c49",
   "personId":78,
   "index":2,
   "externalSessionIdentifier":"f31a836d-42c6-41c7-b0d0-109d64efb133",
   "externalTransactionIdentifier":"b1b2cf19-e9fe-4b7c-be1a-a12f0f8899f2",
   "externalCustomIdentifier":"8cb922ee-01cd-453d-90b9-b377e4f1d38b",
   "transactionId":"8cb922ee-01cd-453d-90b9-b377e4f1c3cb",
   "amount":"5.00"
}

See the full API reference here.

The status indicates whether the transaction was successfully processed or not.

📘

Info

See the full list of the possible status at Transaction Status.