Oney
This page provides an overview of the payments methods provided by the Oney adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating Oney within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.
Payment Methods
| Payment Method | Transaction Flows | Transaction Types |
|---|---|---|
| Creditcard | Redirect | Pre-authorise, Capture, Void, Refund |
Adapter Config
The following fields are mandatory:
| Parameter | Allowed values | Description |
|---|---|---|
| Merchant Guid | Merchant unique global identifier. | |
| pspGuid | PSP unique global identifier. | |
| apiKey | Oney Api Key. | |
| countryCode | Required for header: X-Oney-Partner-Country-Code. | |
| businessTransactionCode | business_transaction code x3 or x4 provided by Oney. |
Pre-Authorise: Additional Parameters
The following extraData fields are mandatory for the pre-authorization (purchase) request:
| Parameter | Allowed values | Description |
|---|---|---|
| extraData.deliveryDate | yyyy-MM-dd | Must be greater or equal to today's date. |
| extraData.deliveryModeCode | Refer to Oney API docs. | |
| extraData.deliveryOption | Refer to Oney API docs. | |
| extraData.deliveryAddressType | Refer to Oney API docs. | |
| extraData.deliveryPriorityDeliveryCode | Refer to Oney API docs. Mandatory if extraData.deliveryOption is 3. | |
| items.item.extraData.isMainItem | Refer to Oney API docs. | |
| items.item.extraData.categoryCode | Refer to Oney API docs. | |
| customer.extraData.languageCode | Refer to Oney API docs. | |
| customer.extraData.honorificCode | 1,2,3 | Refer to Oney API docs. |
| customer.extraData.pickupPointName | Name of delivery point (shop name,...). Mandatory if extraData.addressType is either 1,2 or 3. |
The following extraData fields are optional for the pre-authorization (purchase) request:
| Parameter | Allowed values | Description |
|---|---|---|
| customer.extraData.taxpayerCode | Refer to Oney API docs. |
Refund & Void: Additional Parameters
Additional Information for Refund:
RULES FRANCE ONLY
- payment_amount field can contain a value lower than the initial payment.payment_amount value (sent with the payment request).
- Only one confirm call per payment is possible (the call cancels the rest of the order)
- Between 00h00 et 04h00 it is not possible to confirm an amount different from the original amount of the payment request.
- In case of error during partial or total confirm, the payment goes from FAVORABLE to REFUSED
RULES OTHER COUNTRIES (PT, RO, IT, BE, SP)
- payment_amount field can contain a value lower than the initial payment.payment_amount value (sent with the payment request).
- Several confirm call per payment are possible (no limit)
- The customer will be charged only when the total amount will be confirmed
- Each call must have an item_list according to the goods ready to be shipped.
- Each confirm call will generate a transfer to the merchant regarding the amount confirmed
The following extraData fields are mandatory for the refund request:
| Parameter | Allowed values | Description |
|---|---|---|
| extraData.purchaseCancellationReasonCode | 0, 1 | Refer to Oney API docs. |
| extraData.purchaseRefundDownPayment | true, false | Required if extraData.purchaseCancellationReasonCode is 1. Refer to Oney API docs. |