Get transaction by ID

This method is used to fetch the details of a payment transaction by its transaction ID within a merchant's system

Request example

GET /v1/merchant/{{API_KEY}}/deposits/{{order_id}}
Content-Type: application/json
Host: api-sandbox.bridgerpay.com
Authorization: Bearer {{ACCESS_TOKEN}}

get
Get Transaction by OrderId

<URL>/v1/merchant/{{API_KEY}}/deposits/{{order_id}}
This method is used to fetch the details of a payment transaction by its transaction ID within a merchant's system. Note that this information might be slightly out-of-date since it is retrieved from BridgerPay's database, not from the PSP's.
Request
Response
Request
Path Parameters
API_KEY
required
string
Software-level credentials that identify a merchant and ensure secure access to sensitive information; provided by BridgerPay
order_id
required
string
Transaction ID within the merchant's system
Headers
Content-Type
optional
string
Data format to present information in the response; only "application/json" is supported
Host
optional
string
Web domain identifier
Authorization
required
string
Authorization mechanism: Bearer {{ACCESS_TOKEN}}
Response
200: OK
Successful response
{
"response": {
"status": "OK", //Response status
"code": 200, //Response code
"message": "OK" //Comment associated with the response
},
"result": {
"deposit": {
"psp_name": "PspName", //PSP's real name
"country": "BE", //Shopper's country
"email": "[email protected]", //Shopper's email address
"transaction_id": "8ac7a...1dd", //Transaction ID within the PSP's system
"psp_order_id": "28797...d12", //Transaction group ID within the PSP's system
"merchant_order_id": "h174max7", //Transaction ID within a merchant's system
"amount": "99.95", //Transaction amount
"currency": "EUR", //Transaction currency
"decline_reason": "risk management transaction timeout",
//Reason of why the transaction was declined
"decline_code": "-4", //Declination reason code
"card_type": "VISA", //Organization serving the shopper's debit or credit card; applicable only to the "credit_card" payment method (otherwise, 'null')
"last_four_digits": "1881", //Last four digits of the debit or credit card number; applicable only to the "credit_card" payment method (otherwise, 'null')
"credit_card_expiration": "1023", //Card Expiry date; applicable only to the "credit_card" payment method (otherwise, 'null')
"processing_date": "2020-08-22T09:45:58.4516Z",//Date and time when the transaction was processed by BridgerPay
"payment_method": "credit_card", //Method the shopper used to pay, e.g. "credit_card" or "apm"
"status": "declined", //Transaction status
"cashier_session_id": "3040c500", //Identifier of the Cashier session used
"credit_card_token":null, //Token of the credit card used if the user saved their cc on the cashier
"id": "86705e43", //Transaction ID within the BridgerPay system
"mid_alias": "XYZ" //Mid name identifier
}
}
400: Bad Request
Invalid transaction ID ("order_id") provided or a payment with a requested transaction ID does not exist
{
"response": {
"status": "BadRequest",
"code": 400,
"message": "query_get_order_by_id"
},
"result": [
{
"type": "query_get_order_by_id",
"field": "",
"message": "No records found for the given query, please try again"
}
]
}
401: Unauthorized
1) Attempt to access the resource without authorization (empty response) 2) No API_KEY or invalid API_KEY provided to access the resource
{
"response": {
"code": 401,
"message": "Merchant api key <API_KEY> is invalid"
}
}
404: Not Found
No transaction ID ("order_id") provided (empty response)