> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.deel.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server.

# List of off-cycle payments

GET https://api.letsdeel.com/rest/contracts/{contract_id}/off-cycle-payments

Retrieves all off-cycle payments for a specified contract. Off-cycle payments represent payments made outside the regular payment schedule, such as exceptional or one-time expenses.

 **Token scopes**: `off-cycle-payments:read`

Reference: https://developer.deel.com/api/embedded/ic-endpoints/off-cycle/get-contract-off-cycle-payments

## Authentication

- `Authorization` header (bearer token, required) — ## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
- `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

## Servers

- `https://api.letsdeel.com/rest` (Production, default)
- `https://api-staging.letsdeel.com/rest` (Demo)

## Request

### Path parameters

- `contract_id` (string, required) — The unique identifier (ID) of the Deel contract for which to retrieve off-cycle payments.

## Response

### 200

Successful retrieval of off-cycle payments.

- `data` (list of ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItems, required) — List of off-cycle payments matching the requested contract.

## Errors

### 400 Bad Request Error

Bad Request - The contract_id parameter failed validation.

- `errors` (list of ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Validation errors describing why the off-cycle payments could not be listed.

### 401 Unauthorized Error

Operation failed.

- `request` (ApiErrorRequest, optional)
- `errors` (list of ApiError, optional)

### 403 Forbidden Error

Forbidden - The requesting token is not authorized to list off-cycle payments as a client.

- `errors` (list of ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Errors describing why the off-cycle payments could not be accessed.

### 404 Not Found Error

Not Found - The specified contract does not exist.

- `errors` (list of ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Errors describing why the contract could not be found.

### 500 Internal Server Error

Internal Server Error - The off-cycle payments could not be listed due to an unexpected upstream or internal failure.

- `errors` (list of ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Generic upstream or internal errors emitted when the off-cycle payments cannot be listed.

## Types

### ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItems

- `id` (string, required) — Unique identifier of the off-cycle payment.
- `amount` (string, required) — The amount of the off-cycle payment.
- `status` (enum, required, nullable) — The current status of the off-cycle payment.
  - Allowed values: `approved`, `declined`, `new`, `not_payable`, `paid`, `pending`, `processing`
- `created_at` (string, required) — The timestamp when the off-cycle payment was created.
- `description` (string, required) — A description or reason for the off-cycle payment.
- `reported_by` (ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy, required) — Details of the person who reported the off-cycle payment.
- `currency_code` (string, required) — The three-letter ISO currency code for the payment amount.
- `date_submitted` (string, required) — The timestamp when the off-cycle payment was submitted.

### ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaErrorsItems

- `message` (string, required) — Human-readable error message describing the unexpected condition.
- `code` (string, optional) — Machine-readable error code identifying the failure category.

### ApiErrorRequest

- `method` (string, optional) — The HTTP method of the failed request
- `url` (string, optional) — The relative URL of the failed request
- `status` (double, optional) — The status code of the response
- `api_req_id` (string, optional) — The request ID of the failed request
- `docs` (string, optional) — A link to the official documentation for the requested endpoint resource
- `source` (string, optional) — The source handler which produced the returned error
- `code` (double, optional) — The code of the source handler which produced the returned error

### ApiError

- `message` (string, optional) — A description of the returned error
- `path` (string, optional) — The JSON path where input validation failed

### ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy

Details of the person who reported the off-cycle payment.

- `id` (string, required) — Unique identifier of the reporter.
- `full_name` (string, optional) — Full name of the individual who reported the payment.

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": "500.00",
      "status": "approved",
      "created_at": "2024-11-25T14:30:00.000Z",
      "description": "Reimbursement for travel expenses",
      "reported_by": {
        "id": "00000000-0000-0000-0000-000000000000",
        "full_name": "Jane Doe"
      },
      "currency_code": "USD",
      "date_submitted": "2024-11-20T09:00:00.000Z"
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "amount": "1500.00",
      "status": "pending",
      "created_at": "2024-11-22T10:15:00.000Z",
      "description": "Bonus payment",
      "reported_by": {
        "id": "00000000-0000-0000-0000-000000000000",
        "full_name": "John Smith"
      },
      "currency_code": "EUR",
      "date_submitted": "2024-11-21T15:45:00.000Z"
    }
  ]
}
```

**SDK Code**

```python Example response
import requests

url = "https://api.letsdeel.com/rest/contracts/abcdefg/off-cycle-payments"

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

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

print(response.json())
```

```javascript Example response
const url = 'https://api.letsdeel.com/rest/contracts/abcdefg/off-cycle-payments';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Example response
package main

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

func main() {

	url := "https://api.letsdeel.com/rest/contracts/abcdefg/off-cycle-payments"

	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(res)
	fmt.Println(string(body))

}
```

```ruby Example response
require 'uri'
require 'net/http'

url = URI("https://api.letsdeel.com/rest/contracts/abcdefg/off-cycle-payments")

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

```java Example response
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.letsdeel.com/rest/contracts/abcdefg/off-cycle-payments")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Example response
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.letsdeel.com/rest/contracts/abcdefg/off-cycle-payments', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Example response
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/contracts/abcdefg/off-cycle-payments");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Example response
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/contracts/abcdefg/off-cycle-payments")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```