# Unreferenced Refund (Card Not Present)

**POST /transactions/unreferenced-virtual-refund**

Process an unreferenced refund without a matching completed sale or capture transaction using a hosted payment form / iframe where the card is not physically present. This POST request initiates a refund session and returns a short-lived iframe URL to embed in your refund page, rather than using a static iframe URL.

When the customer submits their card information, they will be redirected to the returnUrl (if provided) or a postMessage event will be sent to the parent window. The complete refund result will be delivered via the Refund Completed webhook.

Note regarding Unreferenced Refunds - Unreferenced refunds are refunds that do not require a previously completed payment transaction to be referenced. They are only available on certain accounts by request to [support@integratedcommerce.io](mailto:support@integratedcommerce.io).

#### Webhook Events

The following webhook events will be triggered during the refund process:
- `refund.completed` - when an unreferenced refund is completed.
- `token.created` - when a card is tokenized and stored as a payment method.



## Servers
- https://api.omni.integratedcommerce.io/v1: https://api.omni.integratedcommerce.io/v1 ()


## Authentication methods
- Api key header


## Parameters



### Body: application/json (object)
The request to process an unreferenced refund using a hosted payment form / iframe.
- **amount** (number(uint32))
  The requested amount to refund.
- **paymentMethodId** (string)
  The ID of the hosted payment form / iframe that will collect card information for this Card Not Present unreferenced refund.

  - Example format: `pmt_vrt_01JRZPTWS99Z7RB57Q1CVWSWDS`
  - OPTIONAL ONLY if you have a single hosted payment form configured
  - REQUIRED if you have multiple hosted payment forms configured

  You can retrieve all available hosted payment form IDs for your account using the [`GET /payment-methods`](#operation-getpaymentmethods) endpoint.
- **invoiceNumber** (string)
  An optional alphanumeric invoice number for this transaction. If provided in the request, the same value will be populated in the response.
- **orderNumber** (string)
  An optional alphanumeric order number for this transaction. If provided, the same value will be populated in the response.
- **referenceId** (string)
  An optional custom reference ID for this transaction. Include this if you want to use your own reference system for linking transactions together (for example, when processing captures and refunds). If provided, this value must be unique per merchant. The reference ID can be used for processing captures and referenced refunds by including it in the originalReferenceId field of subsequent transactions. If not provided, a unique reference ID will be generated automatically by the system.
- **returnUrl** (string)
  Will be used to redirect user back to merchant's site after iframe completed or canceled if provided. The URL will include various parameters that are detailed in "Transaction Result Parameters" section of the Hosted Payment Form section. If you do not provide a returnUrl, the customer will see either a "Payment Processed Successfully" or "Payment Processing Issue" screen.
- **useJavaScriptCallback** (boolean)
  At the end of the transaction flow, the user is always redirected to either the returnUrl (if provided), or a default success or issue page. In addition, if useJavaScriptCallback is set to true, the iframe will use JavaScript to post a message to the parent window to notify the merchant's site when the iframe completed. This allows for more control over the user experience on the merchant's site.


## Responses
### 200
A successful Card Not Present unreferenced refund response

#### Body: application/json (object)
- **id** (string)
  Unique ID for this transaction.
- **paymentMethod** (object)

- **invoiceNumber** (string)
  An optional alphanumeric invoice number for this transaction. If provided in the request, the same value will be populated in the response.
- **orderNumber** (string)
  An optional alphanumeric order number for this transaction. If provided, the same value will be populated in the response.
- **referenceId** (string)
  The reference ID for this transaction. This will either be the reference ID provided in the transaction request or, if no value was provided, a value generated automatically by the system. This reference ID can be used for processing captures and referenced refunds by including it in the originalReferenceId field of subsequent transactions.
- **requestedAmount** (number)
  The amount sent in the transaction request. The amount is always a non-null positive integer in the smallest denomination of the currency (e.g. cents for USD or CAD).
- **sessionId** (string)
  Session ID for the iframe transaction.
- **iframeUrl** (string)
  URL for the iframe to collect payment information, or null if iframe could not be created due to invalid credentials, etc.
- **expirationTimestamp** (string(date-time))
  When the iframe session will expire (UTC).
- **status** (string)
  Status of the iframe session. When created, this will always be pending. The status values will be updated as the customer goes through the iframe process.

### 400
Request Error

#### Body: application/json (object)
- **code** (number)
  Numeric error code. These are grouped into ranges for easier identification and troubleshooting.

   * `1000` - AuthenticationGenericError
   * `2000` - RequestValidationGenericError
   * `3000` - UnknownServerGenericError
   * `9000` - UnhandledGenericError
- **status** (string)
  Execution status of the request sent to the payment gateway.

   * Completed - The request completed successfully.
   * Rejected - The request was rejected by the payment gateway. No action or side effects occurred. The transaction can safely be retried.
   * Interrupted - The request was interrupted, and the final status is unknown. Possible side effects may have occurred (e.g., a Sale (Token) that returns Interrupted might still charge the customer, even if an error is returned). Additional checks are required before retrying the transaction.
   * Unknown
- **message** (string)
  Developer-facing error message.
- **traceId** (string)
  Unique trace identifier for tracking and debugging this request.
- **timestamp** (string(date-time))
  The timestamp when the error occurred (UTC).
- **errorDetails** (array[object])


### 401
Unauthorized response due to an invalid or missing API key.

#### Body: application/json (object)
- **code** (number)
  Numeric error code. These are grouped into ranges for easier identification and troubleshooting.

   * `1000` - AuthenticationGenericError
   * `2000` - RequestValidationGenericError
   * `3000` - UnknownServerGenericError
   * `9000` - UnhandledGenericError
- **status** (string)
  Execution status of the request sent to the payment gateway.

   * Completed - The request completed successfully.
   * Rejected - The request was rejected by the payment gateway. No action or side effects occurred. The transaction can safely be retried.
   * Interrupted - The request was interrupted, and the final status is unknown. Possible side effects may have occurred (e.g., a Sale (Token) that returns Interrupted might still charge the customer, even if an error is returned). Additional checks are required before retrying the transaction.
   * Unknown
- **message** (string)
  Developer-facing error message.
- **traceId** (string)
  Unique trace identifier for tracking and debugging this request.
- **timestamp** (string(date-time))
  The timestamp when the error occurred (UTC).
- **errorDetails** (array[object])



[Powered by Bump.sh](https://bump.sh)