PaymentAccountsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| createPaymentAccount | POST /payment-accounts | Create a new payment account for receiving payouts. |
| listPaymentAccounts | GET /payment-accounts | List all payment accounts accessible to the authenticated user. |
| updatePaymentAccount | PUT /payment-accounts/{id} | Update an existing payment account’s details. |
createPaymentAccount
PaymentAccountResponse createPaymentAccount(PaymentAccountInput)
Create a new payment account for receiving payouts.
Registers a new bank account or payment account with the specified details. Validates account information based on the account type (IBAN, US, CA, etc.) before creation.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| PaymentAccountInput | PaymentAccountInput | Payment account details including name, type, and region-specific account information. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
listPaymentAccounts
PaginatedResponse_PaymentAccountResponse listPaymentAccounts(page, per_page)
List all payment accounts accessible to the authenticated user.
Returns payment accounts owned by the user or associated with vendors they manage. Managers can see all vendor payment accounts, while regular users see only their own.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | [optional] [default to null] | |
| per_page | Integer | [optional] [default to null] |
Return type
PaginatedResponse_PaymentAccountResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updatePaymentAccount
PaymentAccountResponse updatePaymentAccount(id, PaymentAccountInput)
Update an existing payment account’s details.
Modifies the account information for a payment account owned by the user or their managed vendors. All account details including type and account-specific fields can be updated.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | The unique identifier of the payment account to update. | [default to null] |
| PaymentAccountInput | PaymentAccountInput | Updated payment account details including name, type, and account information. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8