Flashpay API
  1. Payouts
Flashpay API
  • Quick Start
    • Overview
    • Configuring the Server
    • Integrating Flashpay in Your Frontend 
  • Payments
    • New payment request
      POST
    • List payments
      GET
    • Payment details
      GET
  • Beneficiaries
    • Eligible beneficiaries list
      GET
  • Payouts
    • New payout request
      POST
    • Payout details
      GET
  1. Payouts

Payout details

GET
/api/v1/payout/{id}
This will return details of the selected payout, with approval update history.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
string 
required

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://example.com/api/v1/payout/'

Responses

🟢200Success
application/json
Body
id
string 
required
amount
integer 
required
currency
string 
required
status
string 
required
beneficiaryId
string 
required
payoutTitle
string 
required
payoutDate
string 
required
createdAt
string 
required
updatedAt
null 
required
beneficiary
object 
required
id
string 
required
bankId
string 
required
accountName
string 
required
accountNumber
string 
required
currency
string 
required
ownerId
string 
required
defaultAccount
boolean 
required
accountType
string 
required
createdAt
string 
required
updatedAt
null 
required
Example
{
  "id": "string",
  "amount": 0,
  "currency": "string",
  "status": "string",
  "beneficiaryId": "string",
  "payoutTitle": "string",
  "payoutDate": "string",
  "createdAt": "string",
  "updatedAt": null,
  "beneficiary": {
    "id": "string",
    "bankId": "string",
    "accountName": "string",
    "accountNumber": "string",
    "currency": "string",
    "ownerId": "string",
    "defaultAccount": true,
    "accountType": "string",
    "createdAt": "string",
    "updatedAt": null
  }
}
Previous
New payout request
Built with