Get payments payout summary

post

/bi/v1/{orgIdentifier}/getPaymentPayoutSummary

First Available Version: 20.2

Gets a summary of payment batch payouts for the specified account and payout date.

Request

Path Parameters
Body ()
The request body defines the details of the API request.
Root Schema : paymentPayoutSummaryPayload
Type: object
Request payload for payment payout summary details
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : paymentPayoutSummaryDimensions
Type: object
The response body contains information about the payment account.
Show Source
Nested Schema : payouts
Type: array
An array of payouts
Show Source
Nested Schema : paymentPayoutSummaryPayouts
Type: object
The response body contains summary of the paymet payouts.
Show Source
  • Title: The batch payout amount
    The amount of the batch payout. This attribute will not be returned in the response if value is 0 or null.
  • Title: Payout currency
    Maximum Length: 3
    Currency of the payout transaction. This attribute will not be returned in the response if value is 0 or null.
  • Title: PSP reference
    Maximum Length: 128
    Reference identifying the payout issued by Payment Service Provider (PSP). This attribute will not be returned in the response if value is 0 or null.
  • Title: Date and Time of the batch payout
    Date and Time of the batch payout in UTC timezone. This attribute will not be returned in the response if value is 0 or null.
  • Title: The amount withheld from the payout
    The amount withheld from the payout. This can happen if upcoming chargeback or refund payouts were to exceed the expected transaction payout amounts on the next payout date. This attribute will not be returned in the response if value is 0 or null.

400 Response

Bad Request
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

401 Response

Unauthorized
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

403 Response

Service Unavailable
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

404 Response

Resource Not Found
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

Default Response

Unexpected Error
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source
Back to Top

Examples

The following example shows how to get the payments account details by submitting a POST request on the REST resource using cURL. For more information, see Use cURL

curl -i -X POST -H "Authorization: Bearer 
  
   " -H "Content-Type:application/json" -d {"payoutDt":"2024-12-24", "acctCode":8516212653197782} https://baseurl/bi/v1/orgidentifier/getPaymentPayoutSummary 
  

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK  Date: Tue, 20 Oct 2020 21:24:33 GMT  Transfer-Encoding: chunked  Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
 "payoutDt": "122024-12-2434",
 "acctCode": "8516212653197782",
 "payouts":[{
   "payoutPspRef": "8836251672789792",
   "payoutUTC": "2014-12-24T11:00:00",
   "payoutCurr": "USD",
   "payoutAmt": 1234.56,
   "wthhldAmt": 1.23
 }]
}
Back to Top