Post Payment

Post a payment to an order or invoice in Prophet 21.

Operation

postPayment

Resource

financial

Parameters

Parameter	Type	Required	Default	Description
Order Number	string	Yes	-	Order number to post payment against
Amount	number	Yes	-	Payment amount (must be greater than zero)
Payment Method	options	Yes	check	Method of payment
Reference Number	string	No	-	Check number, transaction ID, or other reference
Payment Path	string	No	/api/v2/transaction	Endpoint path for posting payment
Include Raw Responses	boolean	No	true	Attach raw response alongside normalized output

Payment Method Options

Value	Label
check	Check
credit_card	Credit Card
ach	ACH
wire	Wire Transfer
cash	Cash

Response

Success

{
  "data": {
    "order_no": "12345",
    "amount": 150.00,
    "payment_method": "credit_card",
    "reference_no": "TXN-789",
    "posted": true
  },
  "raw": {
    "payment": {}
  }
}

Error

{
  "data": {
    "order_no": "12345",
    "posted": false,
    "errors": []
  },
  "raw": {
    "payment": {}
  }
}

Error Handling

• Order Number Required: Order number must be provided
• Invalid Amount: Amount must be greater than zero
• Payment Failed: Returns posted: false with error messages