Administrative APIs | REST

Version:
Download Open API Specification

Submit Manual Refund

https://api.wealthcare.com/system/Services/Transaction/{tpaId}/{employerId}/ManualRefund

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

  • employerId string Required

    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

  • HideFromReports boolean

    Indicates if transaction will display on WCP/WCM or returned on reports. 0 (False) - transaction will not be included/will not be displayed 1 (True) - transaction will be included/displayed

  • ExcludeFromEmployerFunding boolean

    0 (False) 1 (True) Indicates if transaction is excluded from employer funding.

  • IsProxyCard boolean

    0 (False) - Card Number provided in Card Number field 1 (True) – Card Proxy Number provided in Card Number Field.

  • DependentId string
  • DependentSocialSecurityNumber string

    Required if this field is being used as the unique cardholder identifier and card number is not provided. Either this field or Dependent SSN may be used for this purpose.

  • FlexAcctId string

    A system generated unique identifier for the benefit account Either ScCde, (PlanId + PlanYearStartDte + PlanYearEndDte), or FlexAcctID must be passed in so that the refund can be processed.

  • CrossOverClaim boolean

    Indicates if this is a crossover claim, where the payment was automatically deducted from the participant's account 0 (False) 1 (True)

  • OverrideSuspendActivity boolean

    Set to true if overriding a qualified life event that is in Suspended status. 0 (False) 1 (True)

  • CheckEligibility boolean

    0 (False) - WCA does not enforce Participant Eligibility Dates. 1 (True) -  The Service Start Date and Service End Dates must be within the Employee and/or Dependent’s eligibility and termination dates.

  • CheckAcctEligibility boolean

    0 (False)-  The Service Start Date and Service End Dates do not need to be within the Employee and/or Dependent’s eligibility and termination dates. 1 (True) -  The Service Start Date and Service End Dates must be within the Employee and/or Dependent’s eligibility and termination dates.

  • ScCde string

    Service Category Code (SCC) that the refund should be processed with. Either ScCde, (PlanId + PlanYearStartDte + PlanYearEndDte), or FlexAcctID must be passed in so that the refund can be processed.

  • PlanId string

    Plan ID, an identifier configured by the administrator to identify a plan offering. Either ScCde, (PlanId + PlanYearStartDte + PlanYearEndDte), or FlexAcctID must be passed in so that the refund can be processed.

    Min Length: 0
    Max Length: 18
  • AccountTypeCode string

    The account type code for the benefit account the claim is processed under (FSA, DCA, etc.)

  • CardholderId string

    Employee ID or Dependent ID (unique identifiers for the employee or dependent). You must provide either the CardNumber or CardholderSocialSecurityNumber or CardholderID; all are not required. If either or both of the cardholder identifiers (SSN or ID) are provided in addition to card number, card number is used.

  • CardholderSocialSecurityNumber string

    Social Security Number of the employee or dependent. You must provide either the CardNumber or CardholderSocialSecurityNumber or CardholderID; all are not required. If either or both of the cardholder identifiers (SSN or ID) are provided in addition to card number, card number is used.

  • CardNumber string

    Benefit card number. You must provide either the Card Number or Cardholder Social Security Number or Cardholder ID; all are not required. If either or both of the cardholder identifiers (SSN or ID) are provided in addition to card number, card number is used.

  • DateOfServiceFrom string <date-time>

    Service start date for the transaction. The actual date that the cardholder had the service provided.

  • DateOfServiceTo string <date-time>

    Service end date for the transaction. The actual date that the cardholder had the service provided.

  • PlanYearStartDate string <date-time>

    Start date of associated plan. Format: yyyyMMdd Note: If you use unique plan IDs, you do not need to submit plan dates, This is required if Plan ID is not unique. Either ScCde, (PlanId + PlanYearStartDte + PlanYearEndDte), or FlexAcctID must be passed in so that the refund can be processed.

  • PlanYearEndDate string <date-time>

    End date of associated plan. Format: yyyyMMdd Note: If you use unique plan IDs, you do not need to submit plan dates. This is required if Plan ID is not unique. Either ScCde, (PlanId + PlanYearStartDte + PlanYearEndDte), or FlexAcctID must be passed in so that the refund can be processed.

  • DisplayDate string <date-time>

    Date displayed to the employer/employee. Default to Today's date unless date is listed.

  • DisplayToCardholder boolean

    Indicates if transaction will display on WCP/WCM or returned on the participant APIs. 0 (False) - transaction will not be included/will not be displayed to the participant 1 (True) - transaction will be included/displayed to the participant

  • EmployerId string

    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

    Min Length: 0
    Max Length: 18
  • MerchantId string

    Unique number assigned by Visa/MasterCard identifying the submitting merchant

    Min Length: 0
    Max Length: 11
  • MerchantName string

    Name assigned to the merchant ID. Merchant name that shows on transaction.

    Min Length: 0
    Max Length: 22
  • MerchantTypeCode string

    Also referred to as Merchant Category Code. Indicates the type of merchant submitting the transaction. The identifier is encoded into the terminal by the issuing bank and transmitted with every transaction. Note: If the transaction was accepted because of a terminal, merchant, or employee exception, the code is considered a converted MTC. The code is designated as MCC for MasterCard and SIC for Visa.

    Min Length: 0
    Max Length: 4
  • Note string

    Notes on transaction

    Min Length: 0
    Max Length: 255
  • RefundAmount number <double>

    The dollar amount that will be refunded.

  • TpaId string

    A unique identifier for your administrator instance, generated by WCA when the instance was first set up. The API will use the TPA ID associated with the username making the call if not sent.

  • TrackingNumber string

    Tracking Number assigned by the system importing the transaction to WCA

    Min Length: 0
    Max Length: 20
  • TxnApprovedAmt number <double>

    The approved transaction amount.

  • TrackingNumber string

    Tracking Number assigned by the system importing the transaction to WCA

  • TxnAmtOrig number <double>

    The original transaction amount.

  • ErrorCode integer <int32>

    The error code indicating the processing result of the refund. A 0 indicates successful processing.

  • TxnResponseList array <object>
    • AcctTypeCde string

      The type of account the claim was deducted from. FSA, DCA, etc

    • DisbBal number <double>

      The disbursable balance on the account.

    • TxnAmt number <double>

      The transaction amount that processed over the associated account.