List all Payout Requests

List all payout requests.

GET /v2/payout-requests

List all Payout Requests

cURL

curl --request GET \
  --url https://api.dots.dev/api/v2/payout-requests \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.dots.dev/api/v2/payout-requests"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.dots.dev/api/v2/payout-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dots.dev/api/v2/payout-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dots.dev/api/v2/payout-requests"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dots.dev/api/v2/payout-requests")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dots.dev/api/v2/payout-requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

200

{
  "has_more": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "amount": 123,
      "payee": {
        "country_code": "<string>",
        "phone_number": "<string>"
      },
      "payout-link": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created": "2023-11-07T05:31:56Z",
        "link": "<string>",
        "amount": 123,
        "payee": {
          "first_name": "<string>",
          "last_name": "<string>",
          "email": "[e-mail]",
          "country_code": "<string>",
          "phone_number": "<string>"
        },
        "delivery": {
          "email": "[e-mail]",
          "country_code": "<string>",
          "phone_number": "<string>"
        },
        "tax_exempt": true,
        "claimed_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memo": "<string>",
        "metadata": "<string>"
      },
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "[e-mail]",
        "phone_number": {
          "country_code": "<string>",
          "phone_number": "<string>"
        },
        "default_payout_method_details": {
          "id": "<string>",
          "description": "<string>",
          "mask": "<string>",
          "email": "<string>",
          "phone_number": "<string>",
          "cash_tag": "<string>",
          "country": "<string>",
          "currency": "<string>",
          "rtp_enabled": true,
          "meta": "<unknown>"
        },
        "wallet": {
          "amount": 123,
          "withdrawable_amount": 123,
          "credit_balance": 123
        },
        "compliance": {
          "tax_id_collected": true,
          "address_collected": true,
          "date_of_birth_collected": true,
          "must_collect_1099": true,
          "1099_collected": true,
          "w8_ben_collected": true,
          "flagged": true,
          "id_verified": true,
          "has_criminal_activity": true,
          "background_check": {
            "updated": "2023-11-07T05:31:56Z"
          },
          "w9": {
            "business_name": "<string>",
            "tax_id_collected": true,
            "address_collected": true
          },
          "flags": {
            "ofac": true,
            "payout_method": true,
            "payout_method_cycle": true,
            "name_mismatch": true
          }
        },
        "metadata": "<string>",
        "payout_options_exclude_list": []
      },
      "metadata": "<string>",
      "memo": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

limit · integer

A limit on the number of objects to be returned, between 1 and 100.

starting_after · string<uuid>

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with aaa, your subsequent call can include starting_after=aaa in order to fetch the next page of the list.

ending_before · string<uuid>

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with aaa, your subsequent call can include ending_before=aaa in order to fetch the previous page of the list.

Response

200 - application/json

OK

has_more · boolean

true if there are more payout-requests.

data · object[]

Array of payout-request.

Show child attributes