Get deposit by ID

This method is used to fetch the details of a deposit transaction by its transaction ID within the BridgerPay system.

Request example

GET /mpi/{{API_KEY}}/deposit/transaction/{{id}}
Content-Type: application/json
Host: {{API_URL}}
Authorization: Bearer {{ACCESS_TOKEN}}

get
Get MPI transaction

<URL>/mpi/{{API_KEY}}/deposit/transaction/{{id}}
This method is used to fetch the details of a deposit transaction by its transaction ID within the BridgerPay system. Note that this information might be slightly out-of-date since it is retrieved from BridgerPay's database, which is updated in asynchronous mode.
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
id
required
string
Transaction ID within the BridgerPay 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": "success", //Response status
"type": null, //Error type
"code": 200, //Response code
"message": "OK" //Comment associated with the response
},
"result": {
"psp_name": "PspName", //PSP's real name
"country": "BE", //Shopper's country
"email": "[email protected]", //Shopper's email address
"transaction_id": "8ac7a...c9b", //Transaction ID within the PSP's system
"psp_order_id": "9a2b3...546", //Transaction group ID within the PSP's system
"merchant_order_id": "g173aa11", //Transaction ID within the merchant's system
"amount": "15.1", //Transaction amount
"currency": "EUR", //Transaction currency
"decline_reason": null, //Reason of why the transaction was declined
"decline_code": null, //Declination reason code
"card_type": "VISA", //Organization serving the shopper's debit or credit card
"last_four_digits": "1881", //Last four numbers that appear on the shopper's debit or credit card
"processing_date": "2020-09-14T12:47:26.238Z",//Date and time when the transaction was processed by BridgerPay
"payment_method": "credit_card", //Method the shopper used to pay
"status": "in_process", //Transaction status
"cashier_session_id": "a5731...a2e", //Identifier of the Cashier session used
"id": "aeea2...a03" //Transaction ID within the BridgerPay system
}
}
401: Unauthorized
Attempt to access the resource without authorization (empty response)
403: Forbidden
1) Deposit with a requested Transaction ID does not exist (type: "transaction_not_found") 2) Invalid API_KEY provided to access the resource
{
"response": {
"status": "error",
"type": "invalid_api_key"
"code": 403,
"message": "invalid api key used"
},
"result": null
}