USIO PCI
This page provides an overview of the payments methods provided by the USIO PCI adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating USIO PCI within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.
Process Credit Card and Pinless Debit payments via the USIO Payments API.
Supported features
Payment methods
The table below lists the payment methods that USIO PCI supports. It also includes the available processing options and the supported transaction types for each of those payment methods.
| Payment method | Processing options | Transaction types |
|---|---|---|
Credit Card (Creditcard) | Server-to-server | Debit Preauthorize Capture (full and partial) Refund (full and partial) Register Debit and Preauthorize with register |
Pinless Debit (PinlessDebit) | Server-to-server | Debit Preauthorize Capture (full amount only) Void of a preauthorize Refund (full amount only) Register Payout |
The following transaction types are not supported:
| Transaction type | Reason |
|---|---|
| Credit Card void | USIO cannot void an authorization-only transaction. Refund an unsettled payment instead, see Void and refund |
| Credit Card payout | USIO has no push-to-card endpoint |
| Pinless Debit partial refund | Restriction of the Pinless Debit networks. Rejected before it is sent to USIO |
Currencies
USD only. A transaction in any other currency is rejected before it is sent to USIO.
Connector configuration
Connector options and payout credentials are described in the USIO page of the User Manual.
Reporting fields and duplicate check
Debit, Preauthorize and Payout accept the following extraData fields. They are sent to USIO on the payment itself.
USIO's capture, void and refund calls do not accept the reporting fields, so send them on the original Debit or Preauthorize.
On capture, void and refund the DisableDuplicateCheck connector setting always applies; extraData.disableDuplicateCheck is not evaluated there.
extraData key | USIO field | Description |
|---|---|---|
accountCode1 | AccountCode1 | Optional reporting field, max. 20 characters |
accountCode2 | AccountCode2 | Optional reporting field, max. 20 characters |
accountCode3 | AccountCode3 | Optional reporting field, max. 20 characters |
additionalSearch | AdditionalSearch | Optional reporting field, max. 20 characters |
merchantPayAccount | MerchantPayAccount | Optional reporting field, max. 32 characters. See MerchantPayAccount default |
officeId | OfficeID | Optional reporting field, max. 10 characters |
userId | UserID | Optional reporting field, max. 15 characters |
disableDuplicateCheck | DisableDuplicateCheck | true or false. Overrides the DisableDuplicateCheck connector setting for this transaction. Any other value is ignored and the connector setting applies. |
Reporting values are passed to USIO unchanged. A value USIO does not accept, for example one that exceeds the maximum length, is rejected by USIO and returned as a USIO error. Empty values are not sent.
MerchantPayAccount default
The connector option Send merchantTransactionId as MerchantPayAccount if extraData.merchantPayAccount is not set (off by default)
sends the transaction's merchantTransactionId as MerchantPayAccount whenever extraData.merchantPayAccount is missing or empty.
- A non-empty
extraData.merchantPayAccountis always sent as is. - With the option off,
MerchantPayAccountis only sent when the merchant supplies it. - The
merchantTransactionIdis sent unchanged as well. If it can be longer than 32 characters, keep the option off or sendextraData.merchantPayAccountexplicitly.
Register and recurring payments
A Credit Card Register validates the card with a 0.01 USD sale through USIO's Checkout API and reverses it right away. USIO's confirmation of that sale is stored as the USIO token. Debit and Preauthorize with register store the token of the payment itself, without a separate 0.01 USD sale.
A Debit or Preauthorize that references a Register or a payment with register (referenceUuid) on the same connector is processed with the stored USIO token, without card data.
A Pinless Debit Register checks the card with USIO and reverses a 0.01 USD Pinless Debit right away. Pinless Debit payments always send the card from the PCI vault.
Void and refund
USIO uses one operation to reverse a payment and decides itself, based on the settlement state, whether the reversal is a void or a return.
| Operation | Credit Card | Pinless Debit |
|---|---|---|
| Refund of a debit or capture before settlement | Supported, USIO reverses the payment as a void | Supported |
| Refund of a settled payment | Supported, USIO returns the funds | Supported |
| Void of a preauthorize | Not supported | Supported |
The reversal USIO actually performed is returned in the refund's reference data as usioVerifiedOperation, with the value void or refund.
An uncaptured Credit Card preauthorize cannot be cancelled early: it expires with the card issuer. To release the funds sooner, capture the preauthorize and refund the capture.
Pending refunds and voids
USIO does not send notifications. After a refund or a Pinless Debit void is accepted, the outcome is verified with USIO before a result is returned:
- Confirmed void or return: the transaction is
success. - Reported failure: the transaction is
error, with USIO's response code and message. - Not final yet on USIO's side: the transaction is
pending. - Outcome cannot be verified: the transaction is
error. Do not resubmit the refund or void, USIO has already accepted it once. Contact support to have the transaction checked.
A pending refund or void is checked with USIO again, first after 15 minutes and then hourly for up to two days. A postback is sent when the transaction becomes success or error.
If USIO has not finalized the transaction after two days, the transaction is set to error and support verifies it with USIO manually.
Network tokens
Network tokenization is available for Credit Card only. Pinless Debit projects must keep network tokenization disabled:
a Pinless Debit transaction on a project with network tokenization enabled is rejected with Pinless Debit does not support network tokens.