Retrieve payment receipts

Retrieve a list of payments made to Deel, including worker details, payment status, and payment methods. Token scopes: accounting:read

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

date_fromstringOptionalformat: "date"

Filters results to include payments created on or after this date (in ISO 8601 format).

date_tostringOptionalformat: "date"

Filters results to include payments created before this date (in ISO 8601 format).

currencieslist of strings or stringOptional

Filters payments by their currency codes. Can be a single currency code or an array of codes.

entitieslist of enums or enumOptional

Filters payments by legal entity type (e.g., ‘individual’ or ‘company’). Can be a single entity type or an array.

statuseslist of enums or enumOptional

Filters payments by their status (e.g., ‘paid’ or ‘processing’). Can be a single status type or an array.

1	import requests
2
3	url = "https://api.letsdeel.com/rest/v2/payments"
4
5	querystring = {"date_from":"2022-01-01","date_to":"2022-12-31","currencies":"[\"USD\",\"EUR\"]","entities":"[\"company\"]","statuses":"[\"paid\",\"processing\"]"}
6
7	headers = {"Authorization": "Bearer <token>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"data": {
3	"rows": [
4	{
5	"id": "34d7Y48Ymu44g66fghN9F",
6	"label": "string",
7	"status": "paid",
8	"paid_at": "2022-05-24T09:38:46.235Z",
9	"workers": [
10	{
11	"picUrl": "string",
12	"id": "f2f31dd9-06d7-4944-89bd-449b0fd54855",
13	"name": "Jane Doe",
14	"contract_id": "37nex2x"
15	}
16	],
17	"created_at": "2022-05-23T14:45:30.123Z",
18	"payment_method": {
19	"type": "ach"
20	},
21	"payment_currency": "GBP"
22	}
23	],
24	"total": 150,
25	"invoices": [
26	{
27	"id": "invoice-001"
28	}
29	],
30	"timezone": "+02:00"
31	}
32	}

Authentication

Authentication

Query parameters

Response

Errors

Authentication