Get payout details

This method is used to fetch the details of available payout transactions related to a particular merchant.
Request example (bank account, approved)
GET /v1/{{API_KEY}}/payouts?from=0&to=1596117836&pspName=PspName&status=approved&page=1&sort_field=processing_date&limit=24
Content-Type: application/json
Host: {{API_URL}}
Authorization: Bearer {{ACCESS_TOKEN}}
get
Get Payouts
<URL>/v1/{{API_KEY}}/payouts
This method is used to fetch the details of available payout transactions related to a particular merchant. You can apply a set of query parameters here to filter and sort this information accordingly: by PSP, by payout transaction status, etc.
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
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}}
Query Parameters
merchantOrderId
optional
string
Transaction ID within the merchant's system
from
optional
integer
Earliest time point of a period within which payout transactions fall (UTC timestamp; 0 by default)
to
optional
integer
Latest time point of this period
pspName
optional
string
PSP's code name or real name
status
optional
string
Payout transaction status; possible options are "init", "in_process" (for credit cards), "pending" (for bank accounts and other payment types), "authorized", "approved", and "declined"
page
optional
number
Page to start from (1 by default)
sortField
optional
string
Parameter to sort the information by; for now only "processing_date" is applicable (it is used by default)
sortDir
optional
string
Sorting order: "asc" or "desc" (default)
limit
optional
number
Number of payout transactions (records) on one page (24 by default). Note that the maximum number of returned records cannot be limited
Response
200: OK
Successful response
{
  "response": {
    "status": "OK",                                   //Response status
    "code": 200,                                      //Response code
    "message": "OK"                                   //Comment associated with the response
  },
  "result": {
    "next_page_cursor": null,                         //Not applicable
    "records": [
      {
        "id": "aeea2a03",                             //Transaction ID within the BridgerPay system
        "transaction_id": "79f9419a",                 //Transaction ID within a PSP's system
        "psp_name": "PspName",                        //PSP's real name
        "psp_order_id": "24048865",                   //Transaction group ID within the PSP's system
        "merchant_order_id": "676",                   //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": "US",                              //Shopper's country
        "email": "[email protected]",                  //Shopper's email address
        "amount": 4.00,                               //Transaction amount
        "currency": "USD",                            //Transaction currency
        "ip_address": null,                           //Shopper's IP address
        "state": "CA",                                //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-07-30T14:03:48.78159Z//Date and time when the transaction was processed by BridgerPay
        "processing_date_timestamp": 1596117828,      //UTC timstamp 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\":\"676\",                   //Transaction ID within the merchant's system
              \"psp_name\":"psp_name\",               //PSP's code name
              \"charge\": {
                \"type\":\"approved\",                //Transacton status
                \"id\":\"79f9419a\",                  //Transaction ID within the PSP's system
                \"psp_order_id\":\"24048865\",        //Transaction group ID within the PSP's system
                \"attributes\": {
                  \"amount\":4.0,                     //Transaction amount
                  \"status\":\"approved\",            //Transaction status
                  \"currency\":\"USD\",               //Transaction currency
                  \"created_at\":1596117834,          //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\":\"US\"                //Shopper's country
                  }
                },
                \"is_refundable\":false               //Parameter defining whether the transaction was refundable if applicable
              }
            },
            \"meta\": {
              \"server_time\":1596117834,             //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\":\"79f9419a\",     //Transaction ID within the PSP's system
              \"order_id\":\"24048865\"               //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\":90248,                  //Technical parameter provided by the PSP
              \"external_transaction_id\":"18906ead\",//Technical parameter provided by the PSP
              \"order_id\":\"24048865\"               //Transaction group ID within the PSP's system
              \"merchant_order_id\":\"79f9419a\",     //Transaction ID within the PSP's system
              \"amount\":\"4.00\",                    //Transaction amount
              \"currency\":\"USD\",                   //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\":\"24048865\",            //Transaction group ID within the PSP's system
                \"merchant_order_id\":\"79f9419a\",   //Transaction ID within the PSP's system
                \"timestamp\":\"132405914287819262\"  //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": 1596117828,                        //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"
  }
}
Request example (credit card, declined)
Request
Response
Request
GET /v1/{{API_KEY}}/payouts?pspName=PspName&status=declined&limit=1
Content-Type: application/json
Host: api-sandbox.bridgerpay.com
Authorization: Bearer {{ACCESS_TOKEN}}
Response
{
  "response": {
    "status": "OK",
    "code": 200,
    "message": "OK"
  },
  "result": {
    "next_page_cursor": null,
    "records": [
      {
        "id": "40877f24",
        "transaction_id": "85f9daa5",
        "psp_name": "PspName",
        "psp_order_id": "fdc73008",
        "merchant_order_id": "a17331a5",
        "order_description": "null",
        "first_name": "John",
        "last_name": "Smith",
        "address": null,
        "city": null,
        "zip_code": null,
        "country": "BE",
        "email": "[email protected]",
        "amount": 1440.00,
        "currency": "EUR",
        "ip_address": null,
        "state": null,
        "payout_method_type": "CreditCard",
        "decline_reason": "gw: Credits total amount exceeds restrictions , trx: NONE",
        "decline_code": "gw: -1100(1124), trx: 0",
        "status": "Declined",
        "processing_date": "2020-08-20T05:44:49.1360207ZZ",
        "processing_date_timestamp": 1597902289,
        "psp_response_json": {
          "deposit": null,
          "confirm_deposit": null,
          "pre_auth": null,
          "capture": null,
          "purchase": null,
          "confirm_purchase": null,
          "check_status": null,
          "notification": null,               
          "notificaiton_response": null,
          "refund": null,
          "payout": "{
            \"user_token_id\":\"\\\j*****@g****.com\\\"\",
            \"client_unique_id\":\"85f9daa5\",
            \"internal_request_id\":\202820778\",
            \"merchant_id\":\"7001930619669794341\",
            \"merchant_site_id\":\"133193\",
            \"version\":\"1.0\",
            \"client_request_id\":\"f29df205\",
            \"payment_method_error_reason\":"\Credits total amount exceeds restrictions\",
            \"user_payment_option_id\":\"54358838\",
            \external_transaction_id\":\"\",
            \"gw_error_code\":\"-1100\",
            \"gw_error_reason\":\"Credits total amount exceeds restriction\",
            \"gw_extended_error_code\":\"1124\",
            \"status":\"SUCCESS\",
            \"err_code\":\"0\",
            \"reason\":\"\",
            \"transaction_status\":\"ERROR\",
            \"transaction_id\":\"11100020\"
          }",        
          "confirm_payout": null,
          "continue_deposit": null,
          "check_payout_status": null
        },
        "audit_log": [],
        "created": 1597902283,
        "modified": null,
        "is_notification_sent": false,
        "is_notification_received: false
      }
    ]
  }
}
Payouts - Previous
Overview
Next - Payouts
Get payout providers
Last updated 4 months ago
Get payout details

Request example (bank account, approved)

getGet Payouts

Request example (credit card, declined)

get
Get Payouts
