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
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : paymentPayoutSummaryPayload
Type:
object
Request payload for payment payout summary details
Show Source
-
acctCode(required):
string
Title:
Account code
Unique code of the account -
applicationName:
string
Title:
Application name
Maximum Length:128
The name of the application which is accessing the API -
changedSinceUTC:
string(date-time)
Title:
Date and time of a change
The UTC date and time of a change made in the transaction -
include:
string
Title:
Include
Maximum Length:2000
List of objects to include in response -
payoutDt(required):
string(date)
Title:
Payout date
The date on which the batch payout happened -
searchCriteria:
string
Title:
Search criteria
Maximum Length:2000
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : paymentPayoutSummaryDimensions
Type:
object
The response body contains information about the payment account.
Show Source
-
acctCode(required):
string
Title:
Account code
Maximum Length:99
Unique code of the account -
payoutDt(required):
string(date)
Title:
Payout date
The date on which the batch payout happened -
payouts(required):
array payouts
An array of payouts
Nested Schema : payouts
Type:
array
An array of payouts
Show Source
-
Array of:
object paymentPayoutSummaryPayouts
The response body contains summary of the paymet payouts.
Nested Schema : paymentPayoutSummaryPayouts
Type:
object
The response body contains summary of the paymet payouts.
Show Source
-
payoutAmt:
string
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. -
payoutCurr:
string
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. -
payoutPspRef:
string
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. -
payoutUTC:
string(date-time)
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. -
wthhldAmt:
number
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
Root Schema : exceptionDetailType
Type:
object
Exception details
Show Source
-
detail:
string
Title:
Error Description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle Error Code
Oracle error code -
status:
integer
Title:
Status
HTTP Response Code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
object
Exception details
Show Source
-
detail:
string
Title:
Error Description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle Error Code
Oracle error code -
status:
integer
Title:
Status
HTTP Response Code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
object
Exception details
Show Source
-
detail:
string
Title:
Error Description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle Error Code
Oracle error code -
status:
integer
Title:
Status
HTTP Response Code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
object
Exception details
Show Source
-
detail:
string
Title:
Error Description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle Error Code
Oracle error code -
status:
integer
Title:
Status
HTTP Response Code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
object
Exception details
Show Source
-
detail:
string
Title:
Error Description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle Error Code
Oracle error code -
status:
integer
Title:
Status
HTTP Response Code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
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 }] }