Skip to main content
POST
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.

Headers

string,null
Client-generated key; replaying it with an identical body returns the original response. Required by default on this endpoint.

Request body

CreateApPaymentRequest
ApPaymentAllocationRequest[]
string
required
Decimal amount as a string.
string,null
string,null
string,null
string
required
One of check, ach, wire, credit_card, cash, other.
string,null
string
required

Response

ApPaymentResponse
string
required
string
required
string
required
string
required
string
required
string
required
string
required
string
required

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on September 21, 2026