Retrieve a Payout - Cleff API

GET

/

v1

/

payouts

/

{payoutId}

Get a Payout

curl --request GET \
  --url https://api.example.com/v1/payouts/{payoutId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/payouts/{payoutId}', 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.example.com/v1/payouts/{payoutId}",
  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: Bearer <token>"
  ],
]);

$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.example.com/v1/payouts/{payoutId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/payouts/{payoutId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "state": "pending_approval",
  "beneficiary_id": "<string>",
  "bank_account_id": "<string>",
  "amount_minor": 123,
  "purpose_of_payment": "advertising",
  "currency": "<string>",
  "external_ref": {},
  "idempotency_key": "<string>",
  "validator_strategy": "manual",
  "environment": "sandbox",
  "provider": {},
  "provider_payout_id": {},
  "rail_ref": {},
  "replaces_payout_id": {},
  "created_at": "2023-11-07T05:31:56Z",
  "beneficiary_name": {},
  "beneficiary_type": "person",
  "via": {}
}

Authorizations

Authorization

string

header

required

Cleff API key issued to a Business that self-registers via POST /v1/registration

Path Parameters

payoutId

string

required

Response

id

string

required

state

enum<string>

required

Available options:

pending_approval,

approved,

rejected,

disbursed,

failed,

returned,

canceled,

settled,

compliance_hold

beneficiary_id

string

required

bank_account_id

string

required

amount_minor

number

required

purpose_of_payment

enum<string>

required

Why the funds were sent. Provisional corridor-agnostic set.

Available options:

advertising,

advisor_fees,

charity,

education,

family_support,

investment,

loan_repayment,

medical,

other,

payroll,

purchase_of_goods,

purchase_of_services,

real_estate,

royalties,

taxes,

treasury,

travel

currency

string

required

external_ref

object | null

required

idempotency_key

string

required

validator_strategy

enum<string>

required

Available options:

manual

environment

enum<string>

required

Available options:

sandbox,

production

provider

object | null

required

provider_payout_id

object | null

required

rail_ref

object | null

required

replaces_payout_id

object | null

required

created_at

string<date-time>

required

beneficiary_name

object | null

beneficiary_type

enum<string> | null

Available options:

person,

business

via

object | null

Channel through which the Intent arrived.

⌘I

Get a Payout

curl --request GET \
  --url https://api.example.com/v1/payouts/{payoutId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/payouts/{payoutId}', 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.example.com/v1/payouts/{payoutId}",
  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: Bearer <token>"
  ],
]);

$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.example.com/v1/payouts/{payoutId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/payouts/{payoutId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "state": "pending_approval",
  "beneficiary_id": "<string>",
  "bank_account_id": "<string>",
  "amount_minor": 123,
  "purpose_of_payment": "advertising",
  "currency": "<string>",
  "external_ref": {},
  "idempotency_key": "<string>",
  "validator_strategy": "manual",
  "environment": "sandbox",
  "provider": {},
  "provider_payout_id": {},
  "rail_ref": {},
  "replaces_payout_id": {},
  "created_at": "2023-11-07T05:31:56Z",
  "beneficiary_name": {},
  "beneficiary_type": "person",
  "via": {}
}