## List payments

### cURL

```
curl --request GET \
  --url 'https://payouts.api.trykarat.com/payments?limit=100' \
  --header 'Authorization: Bearer <token>'
```

```
import requests

url = "https://payouts.api.trykarat.com/payments?limit=100"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

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

fetch('https://payouts.api.trykarat.com/payments?limit=100', 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://payouts.api.trykarat.com/payments?limit=100",\
  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://payouts.api.trykarat.com/payments?limit=100"

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://payouts.api.trykarat.com/payments?limit=100")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```
require 'uri'
require 'net/http'

url = URI("https://payouts.api.trykarat.com/payments?limit=100")

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
```

### Response

#### Successful Response (200)
```json
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "description": "<string>",
      "referenceId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "statusUpdates": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "processing",
          "reason": "<string>",
          "date": "2023-11-07T05:31:56Z"
        }
      ],
      "recipient": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "jsmith@example.com",
        "autoAcceptPayouts": true
      },
      "payoutLink": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}
```

#### Error Responses

##### Invalid Amount (400)
```json
{
  "error": {
    "message": "amount: amount must be positive"
  }
}
```

##### Invalid API Key (401)
```json
{
  "error": {
    "message": "Invalid api key"
  }
}
```

### Authorization

Authorization
- **Type:** string
- **In:** header
- **Required:** Pass your API key as a bearer token: `Authorization: Bearer <API_KEY>`.

### Query Parameters

- **limit**  
    - **Type:** integer  
    - **Default:** 100  
    - Maximum number of results to return (1 - 100).

- **offset**  
    - **Type:** integer  
    - **Default:** 0  
    - Number of results to skip for pagination.

- **recipientId**  
    - **Type:** string<uuid>  
    - Filter payments by recipient ID.

- **batchId**  
    - **Type:** string<uuid>  
    - Filter payments by the batch they were created in.

- **referenceId**  
    - **Type:** string  
    - Filter payments by your own reference ID.