Download OpenAPI specification:Download
To get started with the Nodabank API, you will need to create API Token in the settings page of your business account dashboard. This key will be used to authenticate your requests and ensure the security of your data. Once you have obtained your API Token, you can start making API calls to interact with the platform.
To authenticate your API requests, you need to include the API Token in the Authorization header of your HTTP requests:
Authorization: Bearer <API_TOKEN>
{- "value": {
- "payouts": [
- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Payroll",
- "description": "Monthly payroll",
- "state": "CREATED",
- "createdAt": "2021-12-31T23:59:59.111Z",
- "startedAt": "2021-12-31T23:59:59.111Z",
- "totalTransfers": 10,
- "paidTransfers": 5,
- "totalAmount": {
- "amount": "100.00",
- "currency": "USDT"
}, - "paidAmount": {
- "amount": "50.00",
- "currency": "USD"
}
}
], - "nextPage": "MjAyMy0wMi0yOFQxNDozMzoyMS4yOThafGRlZmF1bHQ="
}
}Create a new payout
The payout to create
null or string The description of the payout. Example: 'Monthly payroll' | |
null or string The name of the payout. Example: 'Payroll' |
{- "value": {
- "name": "Payroll",
- "description": "Payroll for 12/2024"
}
}{- "value": {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Payroll",
- "description": "Monthly payroll",
- "state": "CREATED",
- "createdAt": "2021-12-31T23:59:59.111Z",
- "startedAt": "2021-12-31T23:59:59.111Z",
- "totalTransfers": 10,
- "paidTransfers": 5,
- "totalAmount": {
- "amount": "100.00",
- "currency": "USDT"
}, - "paidAmount": {
- "amount": "50.00",
- "currency": "USD"
}
}
}Get payout by id
| id required | string Payout's id |
| createdAt required | string Payout's createdAt date and time |
{- "value": {
- "payout": {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Payroll",
- "description": "Monthly payroll",
- "state": "CREATED",
- "createdAt": "2021-12-31T23:59:59.111Z",
- "startedAt": "2021-12-31T23:59:59.111Z",
- "totalTransfers": 10,
- "paidTransfers": 5,
- "totalAmount": {
- "amount": "100.00",
- "currency": "USDT"
}, - "paidAmount": {
- "amount": "50.00",
- "currency": "USD"
}
}, - "transfers": [
- {
- "type": "Crypto",
- "id": "300cf317-3b89-45cf-b07a-803e7834815b",
- "status": "PENDING",
- "createdAt": "2021-12-31T23:59:59.111Z",
- "amount": {
- "amount": "10.00",
- "currency": "USDT"
}, - "amountWithFee": {
- "amount": "10.10",
- "currency": "USDT"
}, - "totalFee": {
- "amount": "0.10",
- "currency": "USDT"
}, - "fromAccount": {
- "id": "797d325e-f578-4ed7-a4bd-5add35b4af3d",
- "name": "USDT Account",
- "balance": {
- "amount": "100.00",
- "currency": "USDT"
}
}, - "toAccount": {
- "id": "a13f842d-db62-4741-8d73-f1f6f143df18",
- "address": "0x1234567890abcdef",
- "network": "TRC20",
- "name": "Alice's Wallet"
}
}
]
}
}Update payout by id
| id required | string Payout's id |
| createdAt required | string Payout's createdAt date and time |
| Idempotency-Key required | string A unique key that can be used to avoid creating duplicate resources |
null or string The description of the payout. Example: 'Monthly payroll' | |
| name required | string [ 0 .. 300 ] characters The name of the payout. Example: 'Payroll' |
{- "value": {
- "name": "Payroll",
- "description": "Monthly payroll"
}
}Create Nodabank transfer
| id required | string Payout's id |
| Idempotency-Key required | string A unique key that can be used to avoid creating duplicate resources |
required | object (Money) The amount to transfer |
null or string The comment for the transfer. Example: 'Salary payment' | |
| receiverUsername required | string [ 3 .. 100 ] characters Customer's username, who should receive funds |
| sourceAccountId required | string <uuid> = 36 characters The unique identifier of account to withdraw the amount. Format: UUID. Example: 123e4567-e89b-12d3-a456-426614174000 |
{- "value": {
- "sourceAccountId": "a893ad17-065d-493b-99d2-d3723e692360",
- "receiverUsername": "jon_doe",
- "amount": {
- "amount": "10.00",
- "currency": "USDT"
}, - "comment": "Salary"
}
}{- "value": {
- "id": "300cf317-3b89-45cf-b07a-803e7834815b",
- "createdAt": "2021-12-31T23:59:59.111Z"
}
}Create fiat/crypto transfer
| id required | string Payout's id |
| Idempotency-Key required | string A unique key that can be used to avoid creating duplicate resources |
required | object (Money) The amount to transfer |
null or Beneficiary (object) | |
null or string The unique identifier of beneficiary to deposit the amount. You should provide beneficiaryId or either beneficiary object. Format: UUID. Example: 123e4567-e89b-12d3-a456-426614174000 | |
null or string The reference for transfer | |
| sourceAccountId required | string <uuid> = 36 characters The unique identifier of account to withdraw the amount. Format: UUID. Example: 123e4567-e89b-12d3-a456-426614174000 |
{- "value": {
- "sourceAccountId": "797d325e-f578-4ed7-a4bd-5add35b4af3d",
- "beneficiary": {
- "accountNumber": "0x973182dB27E929e76BB35ff2C08aec6a90BB7614",
- "currency": "EURT",
- "transferNetworkId": "TRC20"
}, - "amount": {
- "amount": "10.00",
- "currency": "USDT"
}, - "reference": "Salary"
}
}{- "value": {
- "id": "300cf317-3b89-45cf-b07a-803e7834815b",
- "createdAt": "2021-12-31T23:59:59.111Z"
}
}{- "value": {
- "accounts": [
- {
- "id": "797d325e-f578-4ed7-a4bd-5add35b4af3d",
- "name": "USDT Account",
- "balance": {
- "amount": "100.00",
- "currency": "USDT"
}, - "type": "CURRENT",
- "openedAt": "2021-12-31T23:59:59.111Z"
}
]
}
}