DELETE Api/Payment

Reverses an existing payment in the system.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CustomerToken	For consumer payment reversal requests, contains the unique customer token used to identify the customer performing the reversal.	string	None.
InvoiceReversals	Specifies the specific amounts to be refunded per invoice for multi-invoice partial refunds. Omit for cancellations or full refunds.	Collection of PaymentReversalRequestInvoiceModel	None.
OriginalPaymentAmount	Specifies the original amount of the payment to be reversed. Used to verify the lookup.	decimal	Required
OriginalPaymentProcessDate	Specifies the original payment's processing date. Used to verify the lookup.	date-time	Required
Partial	If the refund is a partial amount, set to true. Otherwise should be false or omitted.	boolean	None.
pcOptionalDate	OptionalDate field - additional information required for some of the Payment Consolidator Reversal Reason codes	date-time?	Data type: Date
pcReversalReasonID	Payment Consolidator ReversalReasonID	int?	None.
ReversalAmount	Specifies the partial amount to be refunded. Omit for cancellations, full refunds or multi-invoice partial refunds.	decimal?	None.
ReversalComment	Specifies the description for a refund. Omit for cancellations.	string	String length: inclusive between 0 and 100
TransactionID	Specifies the transaction ID of the payment to be reversed.	long	Required

Request Formats

application/json, text/json

Sample:

{
  "CustomerToken": "sample string 1",
  "InvoiceReversals": [
    {
      "InvoicePaymentID": 1,
      "ReversalAmount": 2.0
    },
    {
      "InvoicePaymentID": 1,
      "ReversalAmount": 2.0
    }
  ],
  "OriginalPaymentAmount": 2.0,
  "OriginalPaymentProcessDate": "2025-05-21T06:35:30.9059938Z",
  "Partial": true,
  "ReversalAmount": 1.0,
  "ReversalComment": "sample string 5",
  "TransactionID": 6,
  "pcReversalReasonID": 1,
  "pcOptionalDate": "2025-05-21T06:35:30.9059938Z"
}

Response Information

Resource Description

Reverses an existing payment in the system.

APIPaymentReversalResponseModel

Name	Description	Type	Additional information
ErrorCode	Name of the error condition. See ErrorCode model for details.	ErrorCode	None.
ErrorID	Internal error identification number that uniquely identifies this specific error that occurred.	string	None.
ErrorNum	Numeric value of the ErrorCode	int	None.
Errors	List of errors that occurred when trying to reverse the payment.	Collection of string	None.
Result		PaymentResponseModel	None.
Success	Indicates sucess or failure of the REST request.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorCode": "None",
  "ErrorID": "sample string 1",
  "ErrorNum": 0,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Result": {
    "AchCompanyID": "sample string 1",
    "AchCompanyName": "sample string 2",
    "AchDepositoryDDA": "sample string 3",
    "AchRoutingTransitNumber": "sample string 4",
    "ApprovedByUserID": 1,
    "ATMTraceID": "sample string 5",
    "BillerID": 6,
    "CCDataProcessingLevel": 7,
    "CcMID": "sample string 8",
    "CellPhone": "sample string 9",
    "Channel": "Enrolled",
    "CombinedFees": [
      {
        "ID": 1,
        "Total": 2.0,
        "CurrencySymbol": "sample string 3"
      },
      {
        "ID": 1,
        "Total": 2.0,
        "CurrencySymbol": "sample string 3"
      }
    ],
    "CreateDate": "2025-05-21T06:35:30.92162Z",
    "CreatedByUserID": 1,
    "CurrencySymbol": "sample string 11",
    "CustomerName": "sample string 12",
    "CustomerToken": "sample string 13",
    "DisplayField1": "sample string 14",
    "DisplayField2": "sample string 15",
    "DisplayField3": "sample string 16",
    "DisplayField4": "sample string 17",
    "DisplayField5": "sample string 18",
    "Email": "sample string 19",
    "EntryField1": "sample string 20",
    "EntryField2": "sample string 21",
    "EntryField3": "sample string 22",
    "EntryField4": "sample string 23",
    "EntryField5": "sample string 24",
    "ExternalUserID": "sample string 25",
    "FDIDescription": "sample string 26",
    "HasMultipleAccounts": true,
    "ID": 28,
    "InvoicePayments": [
      {
        "AccountNumber": "sample string 1",
        "AdditionalFields": {
          "Fields": [
            {
              "BillerId": 1,
              "FieldName": "sample string 2",
              "FieldOrder": 3,
              "FieldText": "sample string 4",
              "FieldValue": "sample string 5",
              "ID": 6,
              "InvoiceId": 7,
              "IsEditable": true,
              "IsRequired": true
            },
            {
              "BillerId": 1,
              "FieldName": "sample string 2",
              "FieldOrder": 3,
              "FieldText": "sample string 4",
              "FieldValue": "sample string 5",
              "ID": 6,
              "InvoiceId": 7,
              "IsEditable": true,
              "IsRequired": true
            }
          ]
        },
        "AddonCode": "sample string 2",
        "AddonName": "sample string 3",
        "Amount": 1.0,
        "AmountDue": 1.0,
        "BillID": 1,
        "BillingAccountDescription": "sample string 4",
        "BillingAccountIsAddOn": true,
        "BillerInvoiceNo": "sample string 6",
        "BillerRemittanceField1": "sample string 7",
        "BillerRemittanceField2": "sample string 8",
        "BillerRemittanceField3": "sample string 9",
        "BillerRemittanceField4": "sample string 10",
        "BillerRemittanceField5": "sample string 11",
        "DisplayField1": "sample string 12",
        "DisplayField2": "sample string 13",
        "DisplayField3": "sample string 14",
        "DisplayField4": "sample string 15",
        "DisplayField5": "sample string 16",
        "DueDate": "2025-05-21T06:35:30.9372561Z",
        "EntryField1": "sample string 17",
        "EntryField2": "sample string 18",
        "EntryField3": "sample string 19",
        "EntryField4": "sample string 20",
        "EntryField5": "sample string 21",
        "FDICode": "sample string 22",
        "FreeformText": "sample string 23",
        "ID": 24,
        "IsAddOn": true,
        "IsCreditMemo": true,
        "PaymentAmount": 1.0,
        "PaymentCode": "sample string 27",
        "PaymentCodeReason": "sample string 28",
        "ReferenceNumber": "sample string 29",
        "RefundableAmount": 30.0,
        "ReversalAmount": 1.0,
        "StatementDate": "2025-05-21T06:35:30.9372561Z",
        "TransactionType": "sample string 31"
      },
      {
        "AccountNumber": "sample string 1",
        "AdditionalFields": {
          "Fields": [
            {
              "BillerId": 1,
              "FieldName": "sample string 2",
              "FieldOrder": 3,
              "FieldText": "sample string 4",
              "FieldValue": "sample string 5",
              "ID": 6,
              "InvoiceId": 7,
              "IsEditable": true,
              "IsRequired": true
            },
            {
              "BillerId": 1,
              "FieldName": "sample string 2",
              "FieldOrder": 3,
              "FieldText": "sample string 4",
              "FieldValue": "sample string 5",
              "ID": 6,
              "InvoiceId": 7,
              "IsEditable": true,
              "IsRequired": true
            }
          ]
        },
        "AddonCode": "sample string 2",
        "AddonName": "sample string 3",
        "Amount": 1.0,
        "AmountDue": 1.0,
        "BillID": 1,
        "BillingAccountDescription": "sample string 4",
        "BillingAccountIsAddOn": true,
        "BillerInvoiceNo": "sample string 6",
        "BillerRemittanceField1": "sample string 7",
        "BillerRemittanceField2": "sample string 8",
        "BillerRemittanceField3": "sample string 9",
        "BillerRemittanceField4": "sample string 10",
        "BillerRemittanceField5": "sample string 11",
        "DisplayField1": "sample string 12",
        "DisplayField2": "sample string 13",
        "DisplayField3": "sample string 14",
        "DisplayField4": "sample string 15",
        "DisplayField5": "sample string 16",
        "DueDate": "2025-05-21T06:35:30.9372561Z",
        "EntryField1": "sample string 17",
        "EntryField2": "sample string 18",
        "EntryField3": "sample string 19",
        "EntryField4": "sample string 20",
        "EntryField5": "sample string 21",
        "FDICode": "sample string 22",
        "FreeformText": "sample string 23",
        "ID": 24,
        "IsAddOn": true,
        "IsCreditMemo": true,
        "PaymentAmount": 1.0,
        "PaymentCode": "sample string 27",
        "PaymentCodeReason": "sample string 28",
        "ReferenceNumber": "sample string 29",
        "RefundableAmount": 30.0,
        "ReversalAmount": 1.0,
        "StatementDate": "2025-05-21T06:35:30.9372561Z",
        "TransactionType": "sample string 31"
      }
    ],
    "InvoicePaymentCount": 29,
    "IsEnrolled": true,
    "IsFees": true,
    "IsFutureDated": true,
    "IsPreSettlement": true,
    "IsReversal": true,
    "IsPaymentConsolidatorPayment": true,
    "Method": "ACH",
    "PaymentAccountAchUsageType": "Unknown",
    "PaymentAccountAchType": "Unknown",
    "PaymentAccountCcChargeType": "Unknown",
    "PaymentAccountCcType": "sample string 36",
    "PaymentAccountCode": "sample string 37",
    "PaymentAccountDescription": "sample string 38",
    "PaymentAccountExpiration": "2025-05-21T06:35:30.9372561Z",
    "PaymentAccountLastFour": "sample string 39",
    "PaymentAccountToken": "sample string 40",
    "PaymentAccountType": "ACH",
    "PaymentAccountSwipe": true,
    "PaymentSource": "sample string 42",
    "pcOptionalDate": "2025-05-21T06:35:30.9528553Z",
    "pcReversalReasonID": 1,
    "PluginName": "sample string 43",
    "Phone": "sample string 44",
    "ProcessDate": "2025-05-21T06:35:30.9528553Z",
    "ProcessingType": "Combined",
    "ReportingID": 46,
    "ReversalReasonCode": "sample string 47",
    "ReversalReasonText": "sample string 48",
    "StandardEntryClass": "ARC",
    "Status": "Initiated",
    "Tender": "sample string 49",
    "Total": 50.0,
    "TotalWithFees": 51.0,
    "TraceID": "sample string 52",
    "TransactionID": 53,
    "TransactionOID": "655832ad-1313-4225-824d-463377920d81",
    "ExternalTransactionID": "sample string 54"
  },
  "Success": true
}