Oney Drop-in integration

This page explains how to add Oney to your existing Web Drop-in integration.

When making a Oney payment request:

1. Collect shopper details and include them in the request.
2. Provide information about the purchased items by specifying lineItems.
3. Make sure that the payment is authorised and successfully captured before you ship the goods.

Requirements

Select the server-side flow that your integration uses:

API reference

Select which endpoint you are using:

Drop-in configuration

Optional configuration

You can add the following optional configuration to configure the visibility of the shopper input fields for Oney :

You can set the visibility to hidden, readOnly or editable.

If you want to add optional configuration, include this in a configuration object. The following example shows how to configure Drop-in to make the deliveryAddress field readOnly:

const oneyConfiguration = {
    visibility: {
        personalDetails: editable, // Optional. These fields will appear on the payment form,
                            // and the shopper can edit them.
                            // This is the default behavior.
        billingAddress: editable, // Optional. These fields will appear on the payment form,
                            // and the shopper can edit them.
                            // This is the default behavior.
        deliveryAddress: readOnly // Optional. These fields will appear on the payment form,
                            // but the shopper cannot edit them.
    };
}

If you created an oneyConfiguration object, include this when creating a configuration object:

If you want to include optional configuration, add the configuration object for each Oney installment type that you support.

Capture the payment

Depending on your capture settings, Oney payments are captured manually or automatically, with or without a delay.

If a payment is captured after more than six days, the payment authorization expires and the payment must be authorised again.

Refund the payment

If a Oney payment has not yet been captured, you can cancel it.

If the payment has already been captured and you want to return the funds to the shopper, you need to refund it.

Partial refunds

To partially refund a Oney payment, specify in your call to the /payments/{paymentPspReference}/refunds endpoint:

• modificationAmount: The amount to be refunded to the shopper.

{
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
   "modificationAmount":{
      "currency":"EUR",
      "value":400
   },
   "originalReference":"8825408195409505"
}

You will receive a /payments/{paymentPspReference}/refunds response containing a pspReference associated with this request. Once we have processed your request, you will also receive a REFUND webhook. For more information, refer to Refund.

Test and go live

Before accepting live Oney payments, test your integration using the following test details:

France

You can test different responses by changing the amount to be paid:

• Authorised: between EUR 150.00 and EUR 999.99
• Pending: between EUR 1000.00 and EUR 1499.99
• Refused: between EUR 1500.00 and EUR 2000.00

To test different responses when making payments in 10 or 12 installments, you need to include the following:

• Authorised:

  • Shopper email: 10X12X.OK.BDE@oney.fr.
  • Under Complétez vos informations, include:
    • Vos revenus: 3500€
    • Origine du revenu principal: Salarie
    • Vos charges: 500€
  • Under Signez votre contrat, include:
    • Phone number: use 0666000000 to bypass a digital signature, or a real phone number to receive the OTP SMS for digital signing.

• Refused:

  • Shopper email: 10X12X.KO.BDE@oney.fr.
  • In the Completez vos informations step, include:
    • Vos revenus: 1000€
    • Origine du revenu principal: Autres
    • Vos charges: 800€

Spain

You can test the different responses by using the following information:

• Authorised:
  • Shopper email: test_ok@oney.com
  • Correct CVV
• Refused:
  • Shopper email: test_ko@oney.com
  • Incorrect CVV

Go live

Before you can accept live Oney payments, you need to submit a request for Oney 3x4x in your live Customer Area.

See also