Skip to main content

Payments API

List Payments​

GET /api/v1/manager-core/payments

Get all payment records.


Update Payment​

PUT /api/v1/manager-core/payments

Request Body:

ParameterTypeRequiredValidation
invoiceintegerConditional*exists:invoices,id (*required_without:payment)
paymentintegerConditional*exists:payments,id (*required_without:invoice)
payment_category_idintegerNo-

Get Accounts​

GET /api/v1/manager-core/payments/accounts

Get payment accounts.


Update Account​

PUT /api/v1/manager-core/payments/accounts

Request Body:

ParameterTypeRequiredValidation
idintegerYesexists:payment_accounts,id
company_idintegerNoexists:companies,id
namestringNo-

Get Cards​

GET /api/v1/manager-core/payments/cards

Get saved payment cards.


Get Statistics​

GET /api/v1/manager-core/payments/statistics

Query Parameters:

ParameterTypeRequiredValidation
warehouseintegerNoexists:warehouses,id
fromdateNoStart date
todateNoEnd date

Pairing to CRM​

POST /api/v1/manager-core/payments/pairing

Request Body:

ParameterTypeRequiredValidation
crm_item_idintegerYesexists:crm_items,id
allbooleanNo-
invoiceintegerConditional*(*required_without:payment)
paymentintegerConditional*(*required_without:invoice)

Payment Methods​

Get Defaults​

GET /api/v1/manager-core/payments/defaults

Get default payment methods.


List Methods​

GET /api/v1/manager-core/payments/methods

Create Method​

POST /api/v1/manager-core/payments/methods

Get Method​

GET /api/v1/manager-core/payments/methods/{id}

Update Method​

PUT /api/v1/manager-core/payments/methods/{id}

Delete Method​

DELETE /api/v1/manager-core/payments/methods/{id}

Translate Method Name​

POST /api/v1/manager-core/payments/methods/{id}/translate

Request Body:

ParameterTypeRequiredValidation
languagestringYesLanguage code
namestringYesTranslated name

Refunds​

Get Refunds​

GET /api/v1/manager-core/payments/refunds

Get all refund records.


Get Bank Transfer Refunds​

GET /api/v1/manager-core/payments/refunds/bank-transfer

Get bank transfer refunds.