Log the Reversal of a Billing Payment

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint allows an external application to send a payment reversal request to Origami. When a previously processed payment is returned by a bank or fails to settle, the external system can call this endpoint to log the reversal. Origami identifies the original payment and creates a reversal transaction, ensuring accurate financial tracking and reconciliation.

Path Params

billingAccountID

integer

required

Unique identifier on billing account domain.

Query Params

paymentID

integer

required

Unique identifier on the billingPayments domain. It is required and must be matched with a BillingPaymentID in Origami in order to reverse that payment.

reversalReasonCode

string

enum

required

Defaults to F

The 1-character code representing the reversal reason. Valid codes include:
E - Incorrect Entry
F - Insufficient Funds
O - Other
S - Security Deposit Transfer
D - Deallocated Billing Payment
C - Account Closed

Allowed:

Body Params

RAW_BODY

json

required

Defaults to { "Description": "Optional transaction description goes here", "Memo": "Optional memo can go here", "PaymentProvider": "PaymentProvider value goes here", "ReferenceNumber": "Optional Reference Number value goes here", "Customtext1": "Optional value goes here" }

This JSON structure can be used to adjust the Description, Memo, PaymentProvider,ReferenceNumber, and any Custom fields in the BillingPayments domain object. See the BillingPayments Data Dictionary for the full schema.

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

{
  "PaymentType": "P",
  "AllocationStatus": "C",
  "Description": "Monthly premium payment failed",
  "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