Creates a payment for a customer.

POST /accounting/payments

Group: Accounting › Payments · Operation ID: createPayment

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.

Request body

Required, application/json: createPaymentInput.

Field Type Required Description
customerId string yes The customer making the payment. See id on GET accounting/customers/:id.
entityId string yes The legal entity receiving the payment. See id on GET base/entities.
amount string (decimal) yes The total payment amount, in the payment currency. Must be greater than 0.
currency string yes The currency the customer paid in. Every amount on the payment is in this currency. Format ISO 4217, for example 'USD'.
paymentDate string (date) yes The date the payment was made. Use format YYYY-MM-DD.
paymentType string, one of "check", "ach", "wire", "creditCard", "directDebit", "sepaCreditTransfer" yes The payment method.
accountId string no The ledger account to post the payment to. Omit to use the entity's configured electronic payment account, which fails with DEFAULT_ACCOUNT_NOT_CONFIGURED when it is not set. See id on GET accounting/accounts/:id.
paymentReference string no The reference the payer supplied with the payment, for example a check or wire reference.
paymentNote string no A free-form note to record on the payment.
bankFeeAmount string (decimal) no The bank fee deducted from the payment, in the payment currency.
thirdPartyPayerId string no The customer actually making the payment, when a third party pays on the invoiced customer's behalf. See id on GET accounting/customers/:id.

Example:

{
  "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amount": "19.99",
  "currency": "<currency>",
  "paymentDate": "2026-01-15",
  "paymentType": "check",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "paymentReference": "<paymentReference>",
  "paymentNote": "<paymentNote>",
  "bankFeeAmount": "19.99",
  "thirdPartyPayerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

200 Success

Under data (createPaymentOutput):

Field Type Required Description
id string yes The unique identifier for the created payment.

Response headers

Errors

Code Status
INVALID_AMOUNT 400
CUSTOMER_NOT_FOUND 400
ENTITY_NOT_FOUND 400
ACCOUNT_NOT_FOUND 400
THIRD_PARTY_PAYER_NOT_FOUND 400
DEFAULT_ACCOUNT_NOT_CONFIGURED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses