Flashpay API
  1. Beneficiaries
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. Beneficiaries

Eligible beneficiaries list

GET
/api/v1/account/accounts
This endpoint will return a list of beneficiaries you are allowed send payouts to.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

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/account/accounts'

Responses

🟢200Success
application/json
Body
array of:
id
string 
optional
bankId
string 
optional
accountName
string 
optional
accountNumber
string 
optional
currency
string 
optional
ownerId
string 
optional
defaultAccount
boolean 
optional
accountType
string 
optional
createdAt
string 
optional
updatedAt
null 
optional
Example
[
  {
    "id": "c52imk98q0njhm3zin2jjlvj",
    "bankId": "dqv8ldz5mk4eu7ykcvrr8g84",
    "accountName": "Alphabets Inc",
    "accountNumber": "1234ABCXXX",
    "currency": "NGN",
    "ownerId": "k235v1ujhhnpwv0zmyk4by6t",
    "defaultAccount": false,
    "accountType": "personal",
    "createdAt": "2024-04-23T07:01:24.844Z",
    "updatedAt": null
  }
]
Previous
Payment details
Next
New payout request
Built with