Payments Test
TXN/Payments/AvailableForRefund?orderIdsOrContributionIds={orderIdsOrContributionIds}
Retrieve cc payments available for refund by processor reference number
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/Payments/AvailableForRefund?orderIdsOrContributionIds={orderIdsOrContributionIds}

URI Parameters

Parameter Name Data Type Required Notes
orderIdsOrContributionIds string N

Request Body

None.
No request body.

Response object type : Collection of PaymentAvailableForRefund

Response object type Collection of PaymentAvailableForRefund has the following properties.
Property Name Data Type Length Required Readonly Notes
AccountId integer
AccountLastFour string
AvailableForRefundAmount decimal number
Id integer
IsLockedInControlledBatch boolean
MerchantId string
OrderIdOrContributionId integer
PaymentAmount decimal number
PaymentDateTime date
PaymentMethod integer
PaymentMethodDescription string
ProcessorReferenceId string 
[
  {
    "AccountLastFour": "sample string 1",
    "ProcessorReferenceId": "sample string 2",
    "PaymentMethod": 3,
    "Id": 4,
    "AvailableForRefundAmount": 5.0,
    "PaymentDateTime": "2025-04-24T05:25:30.8426673-07:00",
    "OrderIdOrContributionId": 6,
    "IsLockedInControlledBatch": true,
    "PaymentAmount": 8.0,
    "PaymentMethodDescription": "sample string 9",
    "MerchantId": "sample string 10",
    "AccountId": 11
  },
  {
    "AccountLastFour": "sample string 1",
    "ProcessorReferenceId": "sample string 2",
    "PaymentMethod": 3,
    "Id": 4,
    "AvailableForRefundAmount": 5.0,
    "PaymentDateTime": "2025-04-24T05:25:30.8426673-07:00",
    "OrderIdOrContributionId": 6,
    "IsLockedInControlledBatch": true,
    "PaymentAmount": 8.0,
    "PaymentMethodDescription": "sample string 9",
    "MerchantId": "sample string 10",
    "AccountId": 11
  }
]
<PaymentsAvailableForRefund xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentAvailableForRefund>
    <AccountId>11</AccountId>
    <AccountLastFour>sample string 1</AccountLastFour>
    <AvailableForRefundAmount>5</AvailableForRefundAmount>
    <Id>4</Id>
    <IsLockedInControlledBatch>true</IsLockedInControlledBatch>
    <MerchantId>sample string 10</MerchantId>
    <OrderIdOrContributionId>6</OrderIdOrContributionId>
    <PaymentAmount>8</PaymentAmount>
    <PaymentDateTime>2025-04-24T05:25:30.8426673-07:00</PaymentDateTime>
    <PaymentMethod>3</PaymentMethod>
    <PaymentMethodDescription>sample string 9</PaymentMethodDescription>
    <ProcessorReferenceId>sample string 2</ProcessorReferenceId>
  </PaymentAvailableForRefund>
  <PaymentAvailableForRefund>
    <AccountId>11</AccountId>
    <AccountLastFour>sample string 1</AccountLastFour>
    <AvailableForRefundAmount>5</AvailableForRefundAmount>
    <Id>4</Id>
    <IsLockedInControlledBatch>true</IsLockedInControlledBatch>
    <MerchantId>sample string 10</MerchantId>
    <OrderIdOrContributionId>6</OrderIdOrContributionId>
    <PaymentAmount>8</PaymentAmount>
    <PaymentDateTime>2025-04-24T05:25:30.8426673-07:00</PaymentDateTime>
    <PaymentMethod>3</PaymentMethod>
    <PaymentMethodDescription>sample string 9</PaymentMethodDescription>
    <ProcessorReferenceId>sample string 2</ProcessorReferenceId>
  </PaymentAvailableForRefund>
</PaymentsAvailableForRefund>
Change Version Description Contract Old New
Property Added 15.1.9 AccountId has been added to PaymentAvailableForRefund PaymentAvailableForRefund PaymentAvailableForRefund.AccountId