Refunds and Cancellations

There may be times where a refund or order cancellation may be necessary. You can use the refundOrCancelOrder mutation to complete this request. In order to use this mutation, you will need to have the applicationId of the loan or lease you would like to refund. If you don't have this saved, you can use our order query to retrieve the applicationId. More information about the order query can be found on Order Lookup.

For this mutation, the input will look something like the following:

{
  "input":{
  "applicationId": 12345678,
  "modificationReason": "refund",
  "adjustmentAmount": "300"
	}
}

applicationId: represents the loan or lease applicationId that the customer used for financing. You can use order query to retrieve this value if you don't have it saved in your system.

modificationReason: represents the reason for initiating the refund or return. This value is an ENUM where possible values are refund or cancel.

adjustmentAmount: represents the dollar amount to be removed from the total amount financed. It should be a positive monetary amount that is less than or equal to the total amount of the lease or loan. If you send any special characters or an amount greater than the loan/lease amount you will get an error.

The refundOrCancelOrder mutation will look something like:

mutation refundOrCancelOrder($input: RefundOrderInput!){
  refundOrCancelOrder(input: $input){
    refundOrderErrors{
      __typename
      ...on FatalError {
        message
      }
      ... on BadRequest {
        message
      }
      
    }
  }
}

The mutation only returns errors, so you will only need to listen for those.

A FatalError will be returned when there is either an internal API error or if a non-numerical value is passed in for adjustmentAmount. The message returned should provide more information on the cause of the error. You many need to adjust your inputs and retry the mutation. If it was due to a downstream error, then you can retry the mutation at a later date.

A BadRequest will be returned when we are unable to retrieve an application for the given applicationId or if there is an error with the adjustmentAmount. The message returned should provide more information on the cause of the error. You will need to adjust your inputs and retry the mutation.

If you continue to encounter errors with this mutation please contact [email protected] for more assistance.