Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

NAPS Redirect Component

Add NAPS to your existing iOS Components integration.

If you have an existing iOS Components integration, you can use our Redirect Component to redirect the shopper to NAPS to complete the payment.

When making an NAPS payment, you need to:

Before you begin

This page explains how to add NAPS to your existing iOS Components integration. The iOS 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 NAPS integration:

  1. Make sure that you have set up your back end implementation for making API requests.
  2. Add NAPS in your test Customer Area.

Show NAPS in your payment form

Include NAPS in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.

We provide logos for NAPS which you can use on your payment form. For more information, refer to Downloading logos.

Make a payment

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

    • paymentMethod.type: Set this to naps.
    • 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. Use the custom URL for your app, for example, my-app://. For more information on setting custom URL schemes, refer to the Apple Developer documentation.
    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":"QAR",
        "value":1000
      },
      "shopperName":{
        "firstName": "Happy",
        "lastName": "Testing",
        "gender": "UNKNOWN"
        }
      "shopperEmail":"shopper@email.com",
      "telephoneNumber":"000000000000",
      "paymentMethod":{
        "type":"naps"
      },
      "returnUrl":"my-app://"
    }'
    # 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 => "QAR",
        :value => 1000
      },
      :reference => "YOUR_ORDER_NUMBER",
      :paymentMethod => {
        :type => "naps"
      },
      :shopperName => {
        :firstName => "Happy",
        :lastName => "Testing",
        :gender => "UNKNOWN"
      },
      :shopperEmail => "shopper@email.com",
      :telephoneNumber => "000000000000",
      :returnUrl => "my-app://",
      :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("QAR");
        amount.setValue(1000L);
        paymentsRequest.setAmount(amount);
    
        DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
        paymentMethodDetails.setType("naps");
        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("my-app://");
    
        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" => "QAR",
        "value" => 1000
      ),
      "reference" => "YOUR_ORDER_NUMBER",
      "paymentMethod" => array(
        "type" => "naps"
      ),
      "shopperName" => [
        "firstName" => "Happy",
        "lastName" => "Testing",
        "gender" => "UNKNOWN"
      ]
      "shopperEmail" => "shopper@email.com",
      "telephoneNumber" => "000000000000"
      "returnUrl" => "my-app://.",
      "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': 'QAR'
       },
       'reference': 'YOUR_ORDER_NUMBER',
       'paymentMethod': {
          'type': 'naps'
       },
       'shopperName': {
          'firstName': 'Happy',
          'lastName': 'Testing',
          'gender' : 'UNKNOWN'
       },
       'shopperEmail': 'shopper@email.com',
       'telephoneNumber': '000000000000',
       'returnUrl': 'my-app://',
       '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("QAR", 1000);
    var details = new Model.Checkout.DefaultPaymentMethodDetails{
      Type = "naps"
    };
    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 = @"my-app://",
      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: "QAR", value: 1000 },
        paymentMethod: {
            type: "naps"
        },
        shopperName: {
            firstName: "Happy",
            lastName: "Testing",
            gender: "UNKNOWN"
        },
        shopperEmail: "shopper@email.com",
        telephoneNumber: "000000000000",
        reference: "YOUR_ORDER_NUMBER",
        merchantAccount: config.merchantAccount,
        returnUrl: "my-app://"
    }).then(res => res);

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

    /payments response
    {
    "resultCode":"RedirectShopper",
    "action":{
      "paymentMethodType":"naps",
      "method":"GET",
      "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
      "type":"redirect"
    }
    }
  2. Pass the action object to your client app.

Handle the redirect

  1. Use the Redirect Component to redirect the shopper to NAPS.

  2. After the shopper returns to your app, make a POST /payments/details request from your server and provide the data from the didProvide method from your client app.
    /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=="
     }
    }'

You receive a response containing:

  • resultCode: Use this to present the 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 NAPS 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 NAPS'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 NAPS. 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 NAPS 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 NAPS payments, use the test card details provided by Tap.
Before you can accept live NAPS payments, you need to submit a request for NAPS in your live Customer Area.

See also