Skip to main content

ReverseBenefitFundingForIndividualInput

An input type used when reversing a previous funding transaction for a benefit and individual.

input ReverseBenefitFundingForIndividualInput {
  amount: MoneyInput
  benefitId: ID!
  description: String
  fundingTransactionId: ID!
  idempotencyKey: String!
  individualId: ID!
}

Fields​

ReverseBenefitFundingForIndividualInput.amount ● MoneyInput input​

Optional partial reversal amount. When provided, must be a positive USD amount no greater than the part of the funding not yet reversed. For an HSA Benefit, it also cannot exceed the Individual's available balance. When omitted, defaults to the full original funding amount. After a partial reversal, omitting the amount requests the full original funding amount again, which exceeds what remains and is rejected, so pass the remainder explicitly.

ReverseBenefitFundingForIndividualInput.benefitId ● ID! non-null scalar​

The ID of the benefit the individual is enrolled in

ReverseBenefitFundingForIndividualInput.description ● String scalar​

Optional human-readable description recorded on the reversal entry.

ReverseBenefitFundingForIndividualInput.fundingTransactionId ● ID! non-null scalar​

The Transaction.id of the funding deposit to reverse, as listed on the Individual's Account.transactions. For a deposit made by 'fundBenefitForIndividual', this is also the 'transactionId' on its FundBenefitForIndividualResult. Deposits made by payroll contributions are reversed the same way, by their Transaction.id. Only funding deposits are supported: a withdrawal, including a prior reversal, is rejected, and the ids of other credits (such as interest or refunds) are not supported.

ReverseBenefitFundingForIndividualInput.idempotencyKey ● String! non-null scalar​

A unique idempotency key for this reversal request. Repeated calls with the same key return the prior result.

ReverseBenefitFundingForIndividualInput.individualId ● ID! non-null scalar​

The ID of the individual whose funding is being reversed

Member Of​

reverseBenefitFundingForIndividual mutation