Get a payout
curl --request GET \
--url https://api.venlyfinance.com/v1/accounts/{accountId}/payouts/{payoutId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.venlyfinance.com/v1/accounts/{accountId}/payouts/{payoutId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.venlyfinance.com/v1/accounts/{accountId}/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.venlyfinance.com/v1/accounts/{accountId}/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.venlyfinance.com/v1/accounts/{accountId}/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))
}HttpResponse<String> response = Unirest.get("https://api.venlyfinance.com/v1/accounts/{accountId}/payouts/{payoutId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venlyfinance.com/v1/accounts/{accountId}/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{
"success": true,
"result": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payoutRoute": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"depositAsset": {
"chain": "AVALANCHE",
"name": "USDC"
},
"fiatCurrency": "USD",
"depositAddress": "<string>",
"beneficiary": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"partyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rail": "US_ACH",
"label": "<string>",
"accountHolderName": "<string>",
"bankName": "<string>",
"details": {
"accountNumberLast4": "9012",
"abaRoutingNumber": "021000021",
"accountType": "CHECKING"
}
}
},
"rail": "US_ACH",
"cryptoAmount": 100,
"settledFiatAmount": 99.5,
"fundingMode": "PULL",
"status": "REQUESTED",
"sendTxHash": "<string>",
"requestedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"failureReason": "<string>"
}
}{
"success": false,
"errors": [
{
"code": "unauthenticated",
"message": "Please authenticate to perform this action."
}
]
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"success": false,
"errors": [
{
"code": "internal-error",
"message": "An unexpected error occurred. Please try again later."
}
]
}Payouts
Get a payout
Read a single pay-out with its masked beneficiary and settlement outcome.
GET
/
accounts
/
{accountId}
/
payouts
/
{payoutId}
Get a payout
curl --request GET \
--url https://api.venlyfinance.com/v1/accounts/{accountId}/payouts/{payoutId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.venlyfinance.com/v1/accounts/{accountId}/payouts/{payoutId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.venlyfinance.com/v1/accounts/{accountId}/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.venlyfinance.com/v1/accounts/{accountId}/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.venlyfinance.com/v1/accounts/{accountId}/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))
}HttpResponse<String> response = Unirest.get("https://api.venlyfinance.com/v1/accounts/{accountId}/payouts/{payoutId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venlyfinance.com/v1/accounts/{accountId}/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{
"success": true,
"result": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payoutRoute": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"depositAsset": {
"chain": "AVALANCHE",
"name": "USDC"
},
"fiatCurrency": "USD",
"depositAddress": "<string>",
"beneficiary": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"partyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rail": "US_ACH",
"label": "<string>",
"accountHolderName": "<string>",
"bankName": "<string>",
"details": {
"accountNumberLast4": "9012",
"abaRoutingNumber": "021000021",
"accountType": "CHECKING"
}
}
},
"rail": "US_ACH",
"cryptoAmount": 100,
"settledFiatAmount": 99.5,
"fundingMode": "PULL",
"status": "REQUESTED",
"sendTxHash": "<string>",
"requestedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"failureReason": "<string>"
}
}{
"success": false,
"errors": [
{
"code": "unauthenticated",
"message": "Please authenticate to perform this action."
}
]
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"success": false,
"errors": [
{
"code": "internal-error",
"message": "An unexpected error occurred. Please try again later."
}
]
}Requires scope:
manage:pay-outs — see Required scopes.
Reads a single pay-out in the full shape: the nested payoutRoute includes the masked beneficiary bank account, plus depositAddress for an ACTIVE route on a SELF_CUSTODY account.
Use this to confirm the real outcome of a pay-out:
settledFiatAmount— the fiat the provider actually paid out. Null untilCOMPLETED, and typically lower than the crypto sent, net of fees.sendTxHash— the on-chain send. The managed broadcast for PULL, the observed customer transaction for PUSH.failureReason— populated forREJECTED,FAILEDandRETURNED.
Authorizations
OAuth2 client credentials flow. Token endpoints:
Path Parameters
Unique account identifier
Unique payout identifier
Was this page helpful?

