Get Payout Transactions
curl --request GET \
--url https://api.atoa.me/api/payouts/{payoutId}/transactions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.atoa.me/api/payouts/{payoutId}/transactions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.atoa.me/api/payouts/{payoutId}/transactions', 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.atoa.me/api/payouts/{payoutId}/transactions",
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.atoa.me/api/payouts/{payoutId}/transactions"
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.atoa.me/api/payouts/{payoutId}/transactions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.atoa.me/api/payouts/{payoutId}/transactions")
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{
"data": [
{
"paymentIdempotencyId": "ATOA1745577029069",
"paymentRequestId": "04869b92-7462-4d89-adbb-c169e735dbaa", // Only present if the payment was processed through the Process-Payment.
"createdAt": "2025-04-25T10:30:36.655Z",
"amount": "123.00",
"currency": "GBP",
"refundId": null,
"refundPaymentReference": null,
"payoutReferenceId": "APY4zt9jjqozv7",
"transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
"isRefund": false,
"callbackParams": {
"test": "67"
}, // Only present if the payment was processed through the Process-Payment.
"notes": "Customer payment for order #12345", // Only present if the payment was processed through the Process-Payment.
"metadata": { // Only present if metadata was supplied when creating the payment.
"bookingId": "BK-42427",
"orderReference": "ORD-1"
}
},
{
"paymentIdempotencyId": "ATOA1745734720994",
"createdAt": "2025-04-27T06:18:48.086Z",
"amount": "162.06",
"currency": "GBP",
"refundId": null,
"refundPaymentReference": null,
"payoutReferenceId": "APY4zt9jjqozv7",
"transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
"isRefund": false
},
{
"paymentIdempotencyId": "ATOA1745577449258",
"createdAt": "2025-04-25T10:37:38.988Z",
"amount": "1000.00",
"currency": "GBP",
"refundId": null,
"refundPaymentReference": null,
"payoutReferenceId": "APY4zt9jjqozv7",
"transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
"isRefund": false
},
{
"paymentIdempotencyId": "ATOA1745557721665",
"createdAt": "2025-04-25T10:35:08.683Z",
"amount": "45.76",
"currency": "GBP",
"refundId": "5e82db42-bc4a-4098-802d-a7be0c5d50ad",
"refundPaymentReference": "ATOA1745557721665",
"payoutReferenceId": "APY4zt9jjqozv7",
"transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
"isRefund": true
}
],
"page": 0,
"itemPerPage": 4,
"totalCount": 4
}
{
"name": "AJV_VALIDATION_ERROR",
"message": "Bad request on parameter \"request.path.id\".\nValue must match format \"uuid\". Given value: \"{payoutId}\"",
"status": 400,
"errors": [
{
"instancePath": "",
"schemaPath": "#/format",
"keyword": "format",
"params": {
"format": "uuid"
},
"message": "must match format \"uuid\"",
"data": "{payoutId}",
"dataPath": ""
}
]
}
{
"name": "INVALID_CREDENTIAL",
"message": "Invalid token",
"status": 401,
"errors": []
}
{
"name": "TRANSACTION_NOT_FOUND",
"message": "No transactions found for this payout",
"status": 404,
"errors": []
}
{
"name": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error",
"status": 500,
"errors": []
}
Payouts
Get Payout Transactions
Retrieve payout transactions via the Atoa Payouts API, request parameters, response schema and code samples in cURL, Python, JavaScript, PHP, Go and Java.
GET
/
api
/
payouts
/
{payoutId}
/
transactions
Get Payout Transactions
curl --request GET \
--url https://api.atoa.me/api/payouts/{payoutId}/transactions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.atoa.me/api/payouts/{payoutId}/transactions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.atoa.me/api/payouts/{payoutId}/transactions', 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.atoa.me/api/payouts/{payoutId}/transactions",
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.atoa.me/api/payouts/{payoutId}/transactions"
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.atoa.me/api/payouts/{payoutId}/transactions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.atoa.me/api/payouts/{payoutId}/transactions")
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{
"data": [
{
"paymentIdempotencyId": "ATOA1745577029069",
"paymentRequestId": "04869b92-7462-4d89-adbb-c169e735dbaa", // Only present if the payment was processed through the Process-Payment.
"createdAt": "2025-04-25T10:30:36.655Z",
"amount": "123.00",
"currency": "GBP",
"refundId": null,
"refundPaymentReference": null,
"payoutReferenceId": "APY4zt9jjqozv7",
"transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
"isRefund": false,
"callbackParams": {
"test": "67"
}, // Only present if the payment was processed through the Process-Payment.
"notes": "Customer payment for order #12345", // Only present if the payment was processed through the Process-Payment.
"metadata": { // Only present if metadata was supplied when creating the payment.
"bookingId": "BK-42427",
"orderReference": "ORD-1"
}
},
{
"paymentIdempotencyId": "ATOA1745734720994",
"createdAt": "2025-04-27T06:18:48.086Z",
"amount": "162.06",
"currency": "GBP",
"refundId": null,
"refundPaymentReference": null,
"payoutReferenceId": "APY4zt9jjqozv7",
"transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
"isRefund": false
},
{
"paymentIdempotencyId": "ATOA1745577449258",
"createdAt": "2025-04-25T10:37:38.988Z",
"amount": "1000.00",
"currency": "GBP",
"refundId": null,
"refundPaymentReference": null,
"payoutReferenceId": "APY4zt9jjqozv7",
"transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
"isRefund": false
},
{
"paymentIdempotencyId": "ATOA1745557721665",
"createdAt": "2025-04-25T10:35:08.683Z",
"amount": "45.76",
"currency": "GBP",
"refundId": "5e82db42-bc4a-4098-802d-a7be0c5d50ad",
"refundPaymentReference": "ATOA1745557721665",
"payoutReferenceId": "APY4zt9jjqozv7",
"transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
"isRefund": true
}
],
"page": 0,
"itemPerPage": 4,
"totalCount": 4
}
{
"name": "AJV_VALIDATION_ERROR",
"message": "Bad request on parameter \"request.path.id\".\nValue must match format \"uuid\". Given value: \"{payoutId}\"",
"status": 400,
"errors": [
{
"instancePath": "",
"schemaPath": "#/format",
"keyword": "format",
"params": {
"format": "uuid"
},
"message": "must match format \"uuid\"",
"data": "{payoutId}",
"dataPath": ""
}
]
}
{
"name": "INVALID_CREDENTIAL",
"message": "Invalid token",
"status": 401,
"errors": []
}
{
"name": "TRANSACTION_NOT_FOUND",
"message": "No transactions found for this payout",
"status": 404,
"errors": []
}
{
"name": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error",
"status": 500,
"errors": []
}
This API retrieves a paginated list of transactions associated with a specific payout ID.
Authorization
Bearer<token>
Path Parameters
string
required
Unique identifier of the payout. This can be obtained from the Payouts
API.
Query Parameters
integer
Maximum number of records to return per page. Default: 10
integer
Page number for pagination, starting from 0. Default: 0
Response
array
List of transaction records
Show Transaction Object
Show Transaction Object
string
Unique identifier for the payment transaction
string
Unique identifier for the payment request. Only present if the payment was processed through the Process Payment API.
string
ISO 8601 timestamp of when the transaction was created
string
Transaction amount with decimal precision
string
Currency code (e.g., GBP)
string
Unique identifier for the refund transaction (null if not a refund). Only present if the transaction was processed through the Refund API.
string
Reference to the original payment being refunded. Only present if the transaction is a refund (when isRefund=true).
string
Reference identifier for the associated payout
string
ISO 8601 timestamp of when the transaction was finalized
boolean
Indicates whether the transaction is a refund (true/false)
object
Optional additional parameters provided in callbacks. Only present if the payment was processed through the Process Payment API.
string
Optional notes associated with the transaction. Only present if the payment was processed through the Process Payment API.
object
Only present when metadata was supplied on the payment. See Process Payment for the field limits.
integer
Current page number
integer
Number of items per page
integer
Total number of records matching the query
{
"data": [
{
"paymentIdempotencyId": "ATOA1745577029069",
"paymentRequestId": "04869b92-7462-4d89-adbb-c169e735dbaa", // Only present if the payment was processed through the Process-Payment.
"createdAt": "2025-04-25T10:30:36.655Z",
"amount": "123.00",
"currency": "GBP",
"refundId": null,
"refundPaymentReference": null,
"payoutReferenceId": "APY4zt9jjqozv7",
"transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
"isRefund": false,
"callbackParams": {
"test": "67"
}, // Only present if the payment was processed through the Process-Payment.
"notes": "Customer payment for order #12345", // Only present if the payment was processed through the Process-Payment.
"metadata": { // Only present if metadata was supplied when creating the payment.
"bookingId": "BK-42427",
"orderReference": "ORD-1"
}
},
{
"paymentIdempotencyId": "ATOA1745734720994",
"createdAt": "2025-04-27T06:18:48.086Z",
"amount": "162.06",
"currency": "GBP",
"refundId": null,
"refundPaymentReference": null,
"payoutReferenceId": "APY4zt9jjqozv7",
"transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
"isRefund": false
},
{
"paymentIdempotencyId": "ATOA1745577449258",
"createdAt": "2025-04-25T10:37:38.988Z",
"amount": "1000.00",
"currency": "GBP",
"refundId": null,
"refundPaymentReference": null,
"payoutReferenceId": "APY4zt9jjqozv7",
"transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
"isRefund": false
},
{
"paymentIdempotencyId": "ATOA1745557721665",
"createdAt": "2025-04-25T10:35:08.683Z",
"amount": "45.76",
"currency": "GBP",
"refundId": "5e82db42-bc4a-4098-802d-a7be0c5d50ad",
"refundPaymentReference": "ATOA1745557721665",
"payoutReferenceId": "APY4zt9jjqozv7",
"transactionFinalizedAt": "2025-04-27T06:30:10.925Z",
"isRefund": true
}
],
"page": 0,
"itemPerPage": 4,
"totalCount": 4
}
{
"name": "AJV_VALIDATION_ERROR",
"message": "Bad request on parameter \"request.path.id\".\nValue must match format \"uuid\". Given value: \"{payoutId}\"",
"status": 400,
"errors": [
{
"instancePath": "",
"schemaPath": "#/format",
"keyword": "format",
"params": {
"format": "uuid"
},
"message": "must match format \"uuid\"",
"data": "{payoutId}",
"dataPath": ""
}
]
}
{
"name": "INVALID_CREDENTIAL",
"message": "Invalid token",
"status": 401,
"errors": []
}
{
"name": "TRANSACTION_NOT_FOUND",
"message": "No transactions found for this payout",
"status": 404,
"errors": []
}
{
"name": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error",
"status": 500,
"errors": []
}