Get payout by ID

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

Request example

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

get
Get Payout transaction by entity id

<URL>/v1/{{API_KEY}}/payouts/{{id}}
This method is used to fetch the details of one payout 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. If you need the latest data from the PSP, use the "Get payout with updated status by ID" method.
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": "OK", //Response status
"code": 200, //Response code
"message": "OK" //Comment associated with the response
},
"result": {
"id": "ca8bb1d8", //Transaction ID within the BridgerPay system
"transaction_id": "8adbb64b", //Transaction ID within a PSP's system
"psp_name": "PspName", //PSP's real name
"psp_order_id": "24049714", //Transaction group ID within the PSP's system
"merchant_order_id": "e17331a4", //Transaction ID within a merchant's system
"order_description": "null", //Comment associated with the transaction
"first_name": "John", //Shopper's first name
"last_name": "Smith", //Shopper's last name
"address": null, //Shopper's address
"city": null, //Shopper's city
"zip_code": null, //Shopper's ZIP code
"country": "BE", //Shopper's country
"email": "[email protected]", //Shopper's email address
"amount": 50.0, //Transaction amount
"currency": "EUR", //Transaction currency
"ip_address": null, //Shopper's IP address
"state": null, //Shopper's state
"payout_method_type": "BankAccount", //Payout method
"decline_reason": null, //Reason of why the transaction was declined
"decline_code": null, //Declination reason code
"status": "Approved", //Transaction status
"processing_date": "2020-08-04T11:19:30.809Z",//Date and time when the transaction was processed by BridgerPay
"processing_date_timestamp": 1596539970, //UTC timestamp of when the transaction was processed by BridgerPay
"psp_response_json": { //Relevant information on the transaction provided by the PSP
"deposit": null, //Information on the transaction if it was a deposit
"confirm_deposit": null, //Transaction confirmation if it was a deposit
"pre_auth": null, //Additional parameter for a deposit transaction
"capture": null, //Additional parameter for a deposit transaction
"purchase": null, //Information on the transaction if it was a purchase
"confirm_purchase": null, //Transaction confirmation if it was a purchase
"check_status": null, //Set of parameters returned by the PSP in case of a check status request
"notification": "{
\"webhook\": {
\"type\":"approved\" //Transaction status
},
\"data\": {
\"order_id\":\"e17331a4\", //Transaction ID within the merchant's system
\"psp_name\":"psp_name\", //PSP's code name
\"charge\": {
\"type\":\"approved\", //Transacton status
\"id\":\"8adbb64b\", //Transaction ID within the PSP's system
\"psp_order_id\":\"24049714\", //Transaction group ID within the PSP's system
\"attributes\": {
\"amount\":50.0, //Transaction amount
\"status\":\"approved\", //Transaction status
\"currency\":\"EUR\", //Transaction currency
\"created_at\":1596539976, //UTC timestamp of when the transaction was registered in the PSP's system
\"updated_at\":0, //UTC timestamp of when information on the transaction was modified in the PSP's system
\"source\": {
\"email\":\"[email protected].com\", //Shopper's email address
\"name\":\"John Smith"\" //Shopper's first and last names
},
\"customer\": {
\"country\":\"BE\" //Shopper's country
}
},
\"is_refundable\":false //Parameter defining whether the transaction was refundable if applicable
}
},
\"meta\": {
\"server_time\":1596539976, //UTC timestamp of when the transaction was registered in the PSP's system according to the server's time
\"server_timezone\":\"UTC\", //Time zone of the PSP's server
\"api_version\":\"1\" //API version the PSP used
}
},
"notificaiton_response": "Status Code:OK Content:{
\"success\":true //Parameter indicating whether the response from the PSP was successful ("true" or "false")
}",
"refund": null, //Information on the transaction if it was a refund
"payout": "{ //Information on the transaction if it was a payout
\"code\":\"200\", //Response code
\"message\":null, //Comment associated with the transaction
\"data\":{
\"merchant_order_id\":\"8adbb64b\", //Transaction ID within the PSP's system
\"order_id\":\"24049714\" //Transaction group ID within the PSP's system
}
}",
"confirm_payout": null, //Transaction confirmation if it was a payout
"continue_deposit": null, //Additional parameter for a deposit transaction
"check_payout_status": "{
\"code":\"200\", //Response code
\"message\":null, //Message associated with the transaction
\"data\":{
\"type\":\"PAYOUT\", //Transaction type
\"status\":\"APPROVED\", //Transaction status
\"error_message\":\"\", //Reason of why the transaction was declined or another relevant message
\"endpoint_id\":90249, //Technical parameter provided by the PSP
\"external_transaction_id\":"caee7040\",//Technical parameter provided by the PSP
\"order_id\":\"24049714\" //Transaction group ID within the PSP's system
\"merchant_order_id\":\"8adbb64b\", //Transaction ID within the PSP's system
\"amount\":\"50.00\", //Transaction amount
\"currency\":\"EUR\", //Transaction currency
\"customer_email\":\"[email protected].com\",//Shopper's email address
\"custom_param\":\"\", //Parameter reserved by the PSP
\"request\":{
\"merchant_id\":"BROK55\", //Merchant ID within the PSP's system
\"order_id\":\"24049714\", //Transaction group ID within the PSP's system
\"merchant_order_id\":\"8adbb64b\", //Transaction ID within the PSP's system
\"timestamp\":\"132410135708090974\" //UTC timestamp (in nsecs) of when the transaction was registered in the PSP's system
}
}
}"
},
"audit_log": [], //Transaction change log; if not empty, it commonly contains two parameters:
//"key" (information on changes to "transaction_id", "psp_order_id", etc.) and
//"json" (relevant information on these changes in irregular string format)
"created": 1596539970, //UTC timestamp of when information on the transaction was registered in the BridgerPay system
"modified": null, //UTC timestamp of when this information was modified last time
"is_notification_sent": false, //Parameter indicating whether BridgerPay sent the merchant the information regarding this request
"is_notification_received": false //Parameter indicating whether the merchant received this information
},
}
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
Payout with a requested transaction ID does not exist
{
"response": {
"status": "NotFound",
"code": 404,
"message": "api_not_found_exception"
}
result: {
"type": "api_not_found_exception",
"field": null,
"message": "transaction not found"
}
}

Other request examples

See Get payout details.