Approve a Payout

POST

payouts

{payoutId}

approve

Approve a Payout (alias)

curl --request POST \
  --url https://api.example.com/v1/payouts/{payoutId}/approve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "decision_id": "<string>",
  "evaluated_at": "2023-11-07T05:31:56Z",
  "reasons": [
    {
      "message": "<string>",
      "details": {}
    }
  ],
  "evaluated_by": {},
  "policy_version": "<string>",
  "agent_version": "<string>",
  "confidence": 123
}
'

import requests

url = "https://api.example.com/v1/payouts/{payoutId}/approve"

payload = {
    "decision_id": "<string>",
    "evaluated_at": "2023-11-07T05:31:56Z",
    "reasons": [
        {
            "message": "<string>",
            "details": {}
        }
    ],
    "evaluated_by": {},
    "policy_version": "<string>",
    "agent_version": "<string>",
    "confidence": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    decision_id: '<string>',
    evaluated_at: '2023-11-07T05:31:56Z',
    reasons: [{message: '<string>', details: {}}],
    evaluated_by: {},
    policy_version: '<string>',
    agent_version: '<string>',
    confidence: 123
  })
};

fetch('https://api.example.com/v1/payouts/{payoutId}/approve', 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}/approve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'decision_id' => '<string>',
    'evaluated_at' => '2023-11-07T05:31:56Z',
    'reasons' => [
        [
                'message' => '<string>',
                'details' => [
                                
                ]
        ]
    ],
    'evaluated_by' => [
        
    ],
    'policy_version' => '<string>',
    'agent_version' => '<string>',
    'confidence' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/v1/payouts/{payoutId}/approve"

	payload := strings.NewReader("{\n  \"decision_id\": \"<string>\",\n  \"evaluated_at\": \"2023-11-07T05:31:56Z\",\n  \"reasons\": [\n    {\n      \"message\": \"<string>\",\n      \"details\": {}\n    }\n  ],\n  \"evaluated_by\": {},\n  \"policy_version\": \"<string>\",\n  \"agent_version\": \"<string>\",\n  \"confidence\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/payouts/{payoutId}/approve")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"decision_id\": \"<string>\",\n  \"evaluated_at\": \"2023-11-07T05:31:56Z\",\n  \"reasons\": [\n    {\n      \"message\": \"<string>\",\n      \"details\": {}\n    }\n  ],\n  \"evaluated_by\": {},\n  \"policy_version\": \"<string>\",\n  \"agent_version\": \"<string>\",\n  \"confidence\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"decision_id\": \"<string>\",\n  \"evaluated_at\": \"2023-11-07T05:31:56Z\",\n  \"reasons\": [\n    {\n      \"message\": \"<string>\",\n      \"details\": {}\n    }\n  ],\n  \"evaluated_by\": {},\n  \"policy_version\": \"<string>\",\n  \"agent_version\": \"<string>\",\n  \"confidence\": 123\n}"

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

{
  "decision": {
    "id": "<string>",
    "decision_id": "<string>",
    "payout_id": "<string>",
    "status": "approved",
    "reasons": [
      {
        "code": "MANUAL_APPROVAL",
        "message": "<string>",
        "details": {}
      }
    ],
    "evaluated_by": {},
    "evaluated_at": "2023-11-07T05:31:56Z",
    "submitted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

payoutId

string

required

Body

application/json

decision_id

string

required

evaluated_at

string<date-time>

required

reasons

object[]

Show child attributes

evaluated_by

object

policy_version

string

agent_version

string

confidence

number

Response

201 - application/json

decision

object

required

Show child attributes

⌘I

Approve a Payout (alias)

curl --request POST \
  --url https://api.example.com/v1/payouts/{payoutId}/approve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "decision_id": "<string>",
  "evaluated_at": "2023-11-07T05:31:56Z",
  "reasons": [
    {
      "message": "<string>",
      "details": {}
    }
  ],
  "evaluated_by": {},
  "policy_version": "<string>",
  "agent_version": "<string>",
  "confidence": 123
}
'

import requests

url = "https://api.example.com/v1/payouts/{payoutId}/approve"

payload = {
    "decision_id": "<string>",
    "evaluated_at": "2023-11-07T05:31:56Z",
    "reasons": [
        {
            "message": "<string>",
            "details": {}
        }
    ],
    "evaluated_by": {},
    "policy_version": "<string>",
    "agent_version": "<string>",
    "confidence": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    decision_id: '<string>',
    evaluated_at: '2023-11-07T05:31:56Z',
    reasons: [{message: '<string>', details: {}}],
    evaluated_by: {},
    policy_version: '<string>',
    agent_version: '<string>',
    confidence: 123
  })
};

fetch('https://api.example.com/v1/payouts/{payoutId}/approve', 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}/approve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'decision_id' => '<string>',
    'evaluated_at' => '2023-11-07T05:31:56Z',
    'reasons' => [
        [
                'message' => '<string>',
                'details' => [
                                
                ]
        ]
    ],
    'evaluated_by' => [
        
    ],
    'policy_version' => '<string>',
    'agent_version' => '<string>',
    'confidence' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/v1/payouts/{payoutId}/approve"

	payload := strings.NewReader("{\n  \"decision_id\": \"<string>\",\n  \"evaluated_at\": \"2023-11-07T05:31:56Z\",\n  \"reasons\": [\n    {\n      \"message\": \"<string>\",\n      \"details\": {}\n    }\n  ],\n  \"evaluated_by\": {},\n  \"policy_version\": \"<string>\",\n  \"agent_version\": \"<string>\",\n  \"confidence\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/payouts/{payoutId}/approve")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"decision_id\": \"<string>\",\n  \"evaluated_at\": \"2023-11-07T05:31:56Z\",\n  \"reasons\": [\n    {\n      \"message\": \"<string>\",\n      \"details\": {}\n    }\n  ],\n  \"evaluated_by\": {},\n  \"policy_version\": \"<string>\",\n  \"agent_version\": \"<string>\",\n  \"confidence\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"decision_id\": \"<string>\",\n  \"evaluated_at\": \"2023-11-07T05:31:56Z\",\n  \"reasons\": [\n    {\n      \"message\": \"<string>\",\n      \"details\": {}\n    }\n  ],\n  \"evaluated_by\": {},\n  \"policy_version\": \"<string>\",\n  \"agent_version\": \"<string>\",\n  \"confidence\": 123\n}"

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

{
  "decision": {
    "id": "<string>",
    "decision_id": "<string>",
    "payout_id": "<string>",
    "status": "approved",
    "reasons": [
      {
        "code": "MANUAL_APPROVAL",
        "message": "<string>",
        "details": {}
      }
    ],
    "evaluated_by": {},
    "evaluated_at": "2023-11-07T05:31:56Z",
    "submitted_at": "2023-11-07T05:31:56Z"
  }
}

Basics

Reference

Authorizations

Path Parameters

Body

Response