Log and Apply a Billing Payment

post

https://{environment}.origamirisk.com/OrigamiApi/api/BillingAccounts/{billingAccountID}/MakePayment

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint records a billing payment in Origami by creating a billing payment record.

It logs the payment and applies it to the appropriate billing invoice.

Path Params

billingAccountID

integer

required

The unique Origami ID/identifier of the Billing Account to post the payment against.

Query Params

paymentDate

string

required

The date on which the external application processed the payment (yyy-mm-dd). Also accepts a full timestamp value including timezone (2026-03-31T18:27:00Z).

paidAmount

double

required

The monetary amount of the payment. Currency is determinded by your configuration and cannot be set for the individual transaction.

paymentMethod

string

enum

required

The 1-character code representing the payment method. Valid codes include:
C - Cash
R - Credit Card
H - Check
D - Debit Card
A - ACH / EFT
F - Applied Funds
L - Lockbox
O - Other

billingInvoiceID

integer

Optional field, maps to BillingInvoices domain. If a value is supplied the payment allocation process allocates this payment directly to the invoice.

Body Params

RAW_BODY

json

required

Defaults to { "PaymentType": "P", "AllocationStatus": "D", "AllocatedAmount": 1000.00, "CheckNumber": 123, "Memo":"Memo text goes here" }

This is a JSON object representing the key-value data of the BillingPayments domain object.

See the Billing Payments Data Dictionary for a full view of this object.

Your schema may vary, but it could potentially look something like:

{
  "PaymentType": "P",
  "AllocationStatus": "C",
  "Description": "Monthly premium payment",
  "CheckNumber": "CHK-982374",
  "Memo": "Processed via lockbox",
  "PaymentProvider": "AcmePayments",
  "ReferenceNumber": "REF-20260331-01",
  "AllocatedAmount": 1250.75,
  "ReverseOfPaymentID": 0,
  "ReverseReasonCode": "O",
  "EntryUserID": 1024,
  "EntryDate": "2026-03-31T16:45:00Z",
  "ModifiedUserID": 1024,
  "ModifiedDate": "2026-03-31T17:10:00Z",
  "SystemGenerated": false,
  "RefundBillingInvoiceID": 0,
  "OnlineTransactionID": 554433,
  "IsReversed": false,
  "DraftAllocations": null,
  "IsHistorical": false,
  "ParentBillingPaymentID": 0,
  "AllocationMode": "B",
  "RefundedAmount": 0.00,
  "BillingPaymentSubTypeID": 3,
  "WaiveFeesReasonCode": "C",
  "NewPayeeType": "N",
  "PayeeMemberID": 456789,
  "PayeeContactID": 0,
  "PayeeBrokerID": 0,
  "AutoRefundScriptResult": true
}

Response

200