No momento, esta página não está disponível em português

Benefit Component

Add Benefit to an existing Components integration.

On this page, you can find additional configuration for adding Benefit to your Components integration.

Before you begin

This page assumes you've already:

API reference

Select which endpoint you're integrating:

This is the default with Components v5.0.0 or later.

Parameter name	Required	Description
shopperName		The shopper's full name.
shopperEmail		The shopper's email address.
telephoneNumber		The shopper's telephone number.

curl https://checkout-test.adyen.com/v69/sessions \
-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",
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
}'

https://docs.adyen.com/pt/pt/payment-methods/benefit/web-component#tap-redirect-sessions

If you implemented an additional use case.

Parameter name	Required	Description
shopperName		The shopper's full name.
shopperEmail		The shopper's email address.
telephoneNumber		The shopper's telephone number.

curl https://checkout-test.adyen.com/v68/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 Adyen.Model.Checkout.Amount("BHD", 1000);
var details = new Adyen.Model.Checkout.DefaultPaymentMethodDetails{
  Type = "benefit"
};
var shopperName = new Adyen.Model.Checkout.Name{
  FirstName = "Happy",
  LastName = "Testing"
};
var paymentsRequest = new Adyen.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);

https://docs.adyen.com/pt/pt/payment-methods/benefit/web-component#tap-redirect-payments

Component configuration

Step 1: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:

 <div id="benefit-container"></div>

Step 2: Create an instance of the Component

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component:

const benefitComponent = checkout.create('benefit').mount('#benefit-container');

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.