Fetch a Batch Payout ( Processor Only ) ( SUNSETTING )
curl --request GET \
--url https://api.grailpay.com/processor/api/v1/batchpayout/{payout_uuid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.grailpay.com/processor/api/v1/batchpayout/{payout_uuid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.grailpay.com/processor/api/v1/batchpayout/{payout_uuid}', 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.grailpay.com/processor/api/v1/batchpayout/{payout_uuid}",
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.grailpay.com/processor/api/v1/batchpayout/{payout_uuid}"
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.grailpay.com/processor/api/v1/batchpayout/{payout_uuid}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.grailpay.com/processor/api/v1/batchpayout/{payout_uuid}")
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{
"status": true,
"message": "",
"data": {
"total": 4400,
"direction": "credit",
"modality": {
"payment_rail": "fednow",
"speed": "instant"
},
"payee_id": [
{
"payee_id": "0cda5458-660f-4f12-9447-e432da2f959c",
"total": 4400,
"transactions": [
{
"transaction_id": "9ccf5706-dff0-46c7-bf74-4e34dc998485",
"client_reference_id": "typesetting",
"amount": 4400
}
]
}
]
},
"errors": null,
"error_code": null
}{
"status": false,
"message": "Invalid Token",
"data": null,
"errors": null,
"error_code": null
}{
"status": false,
"message": "Batch payout not found.",
"data": null,
"errors": null,
"error_code": null
}Payouts
Fetch a Batch Payout ( Processor Only ) ( SUNSETTING )
This Endpoint is Sunsetting and you should use the stable endpoint. Sunsetting APIs that are still supported but scheduled for deprecation.
GET
/
processor
/
api
/
v1
/
batchpayout
/
{payout_uuid}
Fetch a Batch Payout ( Processor Only ) ( SUNSETTING )
curl --request GET \
--url https://api.grailpay.com/processor/api/v1/batchpayout/{payout_uuid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.grailpay.com/processor/api/v1/batchpayout/{payout_uuid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.grailpay.com/processor/api/v1/batchpayout/{payout_uuid}', 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.grailpay.com/processor/api/v1/batchpayout/{payout_uuid}",
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.grailpay.com/processor/api/v1/batchpayout/{payout_uuid}"
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.grailpay.com/processor/api/v1/batchpayout/{payout_uuid}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.grailpay.com/processor/api/v1/batchpayout/{payout_uuid}")
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{
"status": true,
"message": "",
"data": {
"total": 4400,
"direction": "credit",
"modality": {
"payment_rail": "fednow",
"speed": "instant"
},
"payee_id": [
{
"payee_id": "0cda5458-660f-4f12-9447-e432da2f959c",
"total": 4400,
"transactions": [
{
"transaction_id": "9ccf5706-dff0-46c7-bf74-4e34dc998485",
"client_reference_id": "typesetting",
"amount": 4400
}
]
}
]
},
"errors": null,
"error_code": null
}{
"status": false,
"message": "Invalid Token",
"data": null,
"errors": null,
"error_code": null
}{
"status": false,
"message": "Batch payout not found.",
"data": null,
"errors": null,
"error_code": null
}Authorizations
Token-based authentication using Authorization: Bearer <YOUR_API_KEY> provided by the GrailPay Support Team.
Path Parameters
Payout UUID
Example:
"9bd53fe1-ac74-4e81-b6f2-be88b7c86a68"
⌘I
