Pesquisar

Are you looking for test card numbers?

Would you like to contact support?

Atenção, esta página não se encontra disponível em Português
Payment-method icon

Benefit Component

Add Benefit to an existing Components integration.

Our Benefit Component renders Benefit in your payment form. As with other redirect payment methods, you need to use createFromAction to redirect the shopper, and handle the redirect after the shopper returns to your website.

Before you begin

This page explains how to add Benefit to your existing Web Components integration. The Web Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your Benefit integration:

  1. Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
  2. Add Benefit in your Customer Area.

Show Benefit in your payment form

To present the Benefit Component in your payment form:

  1. From your server, make a POST /paymentMethods request specifying:

  2. Pass the full response from the /paymentMethods call as the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

  3. Add the Benefit Component:
    a. Create a DOM element for Benefit, placing it where you want the form to be rendered:
    <div id="Benefit-container"></div>

    b. Create and mount an instance of the Benefit Component using its component name, Benefit. This renders a button on your payment form.

    function handleOnSubmit(state, component) {
        // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
        state.isValid // True or false. Specifies if all the information that the shopper provided is valid.
        state.data // Provides the data that you need to pass in the `/payments` call.
        component // Provides the active component instance that called this event.
    }
    const BenefitComponent =  checkout.create('Benefit', {
        onSubmit: handleOnSubmit // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
    }).mount('#Benefit-container');

    When the shopper selects the payment method, the Component calls the onSubmit event, which contains a state.data object including the shopper's selected payment method. If your integration is set up correctly, the state.data is passed on to your server.

Make a payment

From your server, make a POST /payments request, specifying:

  • paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.
  • shopperName: The shopper's full name.
  • shopperEmail: The shopper's email address.
  • telephoneNumber: The shopper's telephone number.
  • returnUrl: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol: http:// or https://. For example, https://your-company.com/checkout/. You can also include your own additional query parameters, for example, shopper ID or order reference number.

Here is how you would make a payment for 10 BHD.

curl https://checkout-test.adyen.com/v67/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"BHD",
    "value":1000
  },
  "shopperName":{
    "firstName": "Happy",
    "lastName": "Testing",
    "gender": "UNKNOWN"
    }
  "shopperEmail":"shopper@email.com",
  "telephoneNumber":"000000000000",
  "paymentMethod":{
    "type":"Benefit"
  },
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy..."
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "BHD",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "Benefit"
  },
  :shopperName => {
    :firstName => "Happy",
    :lastName => "Testing",
    :gender => "UNKNOWN"
  },
  :shopperEmail => "shopper@email.com",
  :telephoneNumber => "000000000000",
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy...",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
    Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
    Checkout checkout = new Checkout(client);

    PaymentsRequest paymentsRequest = new PaymentsRequest();

    String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
    paymentsRequest.setMerchantAccount(merchantAccount);

    Amount amount = new Amount();
    amount.setCurrency("BHD");
    amount.setValue(1000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setType("Benefit");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);

    Name shopperDetails = new Name();
    shopperDetails.setFirstName("Happy");
    shopperDetails.setLastName("Testing");
    shopperDetails.setGender(Name.GenderEnum.UNKNOWN);

    paymentsRequest.setShopperName(shopperDetails);
    paymentsRequest.setShopperEmail("shopper@email.com");
    paymentsRequest.setTelephoneNumber("000000000000");
    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy...");

    PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "BHD",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "Benefit"
  ),
  "shopperName" => [
    "firstName" => "Happy",
    "lastName" => "Testing",
    "gender" => "UNKNOWN"
  ]
  "shopperEmail" => "shopper@email.com",
  "telephoneNumber" => "000000000000"
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy....",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'BHD'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'Benefit'
   },
   'shopperName': {
      'firstName': 'Happy',
      'lastName': 'Testing',
      'gender' : 'UNKNOWN'
   },
   'shopperEmail': 'shopper@email.com',
   'telephoneNumber': '000000000000',
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy...',
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Model.Checkout.Amount("BHD", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "Benefit"
};
var shopperName = new Model.Checkout.Name{
  FirstName = "Happy",
  LastName = "Testing",
  Gender = Model.Checkout.Name.GenderEnum.UNKNOWN
}
var paymentsRequest = new Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy...",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details,
  ShopperName = shopperName,
  ShopperEmail = "shopper@email.com",
  TelephoneNumber = "000000000000"
};

var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "BHD", value: 1000 },
    paymentMethod: {
        type: "Benefit"
    },
    shopperName: {
        firstName: "Happy",
        lastName: "Testing",
        gender: "UNKNOWN"
    },
    shopperEmail: "shopper@email.com",
    telephoneNumber: "000000000000",
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..."
}).then(res => res);

The /payments response contains an action object with the information needed to redirect the shopper.

/payments response
{
   "resultCode":"RedirectShopper",
   "action":{
      "paymentMethodType":"Benefit",
      "method":"GET",
      "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
      "type":"redirect"
   }
}

If your integration is set up correctly, the action object is passed from your server to the client.

Handle the redirect

Handling the redirect works the same way for all redirect payment methods:

  1. Call createFromAction, passing the action object from the previous step. This will return a new Component that you need to mount:
    checkout.createFromAction(action).mount('#my-container');
    The Component redirects the shopper to complete the payment.
  2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
    • details: Object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.
    /payments/details request
    curl https://checkout-test.adyen.com/v67/payments/details \
    -H "x-API-key: YOUR_X-API-KEY" \
    -H "content-type: application/json" \
    -d '{
       "details": {
         "redirectResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ=="
     }
    }'
    The /payments/details response contains:
    • resultCode: Use this to present the payment result to your shopper.
    • pspReference: Our unique identifier for the transaction.
    /payments/details response
    {
        "resultCode": "Authorised",
        "pspReference": "88154795347618C"
    }

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for Benefit are:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
Cancelled The shopper cancelled the payment while on Benefit's website. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error There was an error when the payment was being processed. Inform the shopper that there was an error processing their payment. The response contains a refusalReason, indicating the cause of the error.
Pending or
Received
The shopper has completed the payment but the final result is not yet known. Inform the shopper that you've received their order, and are waiting for the payment to be completed.

To know the final result of the payment, wait for the AUTHORISATION notification webhook.
Refused The payment was refused by the Benefit. Ask the shopper to try the payment again using a different payment method.

If the shopper closed the browser and failed to return to your website, wait for notification webhooks to know the outcome of the payment. The notification webhooks you can receive for Benefit are:

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment has been successful and proceed with the order.
OFFER_CLOSED true The shopper did not complete the payment. Cancel the order and inform the shopper that the payment timed out.

Test and go live

To test Benefit payments, use the test card details provided by Tap.
Before you can accept live Benefit payments, you need to submit a request for Benefit in your live Customer Area.

See also