Payouts List

A list of upcoming payouts

To make this request, send an authenticated request to the payouts endpoint.

Get a list of upcoming payouts

GET https://api.oneappgo.com/v1/business/payouts

Take a look at how you might do this:

cURL

curl --location --request GET 'https://api.oneappgo.com/v1/business/payouts' \
--header 'Authorization: Bearer YOUR_SECRET_KEY'

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'GET',
  'hostname': 'api.oneappgo.com',
  'path': '/v1/business/payouts',
  'headers': {
    'Authorization': 'Bearer YOUR_SECRET_KEY'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

req.end();

PHP - cURL

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.oneappgo.com/v1/business/payouts',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer YOUR_SECRET_KEY'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Python

import requests

url = "https://api.oneappgo.com/v1/business/payouts"

payload={}
headers = {
  'Authorization': 'Bearer YOUR_SECRET_KEY'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Sample response

{
    "status": true,
    "totalpayout": 7,
    "message": "Payout retrieved",
    "data": [
        {
            "payoutid": "31",
            "busnessid": "7",
            "amount": "20",
            "settled": "20.00",
            "payoutref": "76BY14H704301C4R",
            "total": "2",
            "payout_date": "28, January 2022",
            "statuscode": "2",
            "bizname": "Testing",
            "payoutstatus": "Paid"
        },
        {
            "payoutid": "28",
            "busnessid": "7",
            "amount": "100",
            "settled": "100.00",
            "payoutref": "7636AS0KD04T1145",
            "total": "1",
            "payout_date": "24, January 2022",
            "statuscode": "2",
            "bizname": "Testing",
            "payoutstatus": "Paid"
        },
        {
            "payoutid": "22",
            "busnessid": "7",
            "amount": "40",
            "settled": "40.00",
            "payoutref": "759604BO4ASL2180",
            "total": "4",
            "payout_date": "21, January 2022",
            "statuscode": "2",
            "bizname": "Testing",
            "payoutstatus": "Paid"
        },
        {
            "payoutid": "18",
            "busnessid": "7",
            "amount": "10",
            "settled": "10.00",
            "payoutref": "76JH0W4019J051J4",
            "total": "1",
            "payout_date": "30, December 2021",
            "statuscode": "2",
            "bizname": "Testing",
            "payoutstatus": "Paid"
        },
        {
            "payoutid": "6",
            "busnessid": "7",
            "amount": "100",
            "settled": "100.00",
            "payoutref": "7J30T5731R1X967K",
            "total": "1",
            "payout_date": "24, November 2021",
            "statuscode": "2",
            "bizname": "Testing",
            "payoutstatus": "Paid"
        },
        {
            "payoutid": "5",
            "busnessid": "7",
            "amount": "900",
            "settled": "900.00",
            "payoutref": "7N16W9GL6577Z834",
            "total": "1",
            "payout_date": "24, November 2021",
            "statuscode": "2",
            "bizname": "Testing",
            "payoutstatus": "Paid"
        },
        {
            "payoutid": "4",
            "busnessid": "7",
            "amount": "100",
            "settled": "100.00",
            "payoutref": "7Q6J3Q400173PP78",
            "total": "1",
            "payout_date": "23, November 2021",
            "statuscode": "2",
            "bizname": "Testing",
            "payoutstatus": "Paid"
        }
    ]
}