Payment-method icon

ANCV for API only

Add ANCV to an existing API-only integration.

Accept ANCV payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Requirements

Requirement Description
Integration type Make sure that you have built an API-only integration.
Setup steps Before you begin, add ANCV in your test Customer Area.

Build your payment form for ANCV

Include ANCV as an available payment method in your payment form.

Use the /paymentMethods request to show available payment methods to the shopper. Specify these parameters:

  • countryCode: FR
  • amount.currency: EUR

The response contains paymentMethod.type: ancv.

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

Make a payment

When a shopper chooses to pay with ANCV, you need to collect the shopper's ANCV ID and wait for the payment outcome on your website.

In your /payments request, specify:

  • paymentMethod.type: ancv
  • paymentMethod.beneficiaryId: string - This is the ANCV ID of the shopper collected during the checkout (either email address or 11-digit value).

The response contains:

  • resultCode: Pending - the shopper still needs to complete the payment in the ANCV app
  • order.orderData - ignore this value and take the order.orderData from the /payments/details response
  • action.paymentData - payload required as an input for /payments/details request in order to learn about the payment status

Show the waiting screen

  1. Show a waiting screen to the shopper, telling them you are waiting for them to complete the payment.
  2. Once the shopper completes the payment, present the payment result.

Get outcome

To see the payment result, send a request to /payments/details that includes the paymentData provided in the /payments response.

The response for when the amount authorised is less than the amount requested:

The response for when the amount authorised is equal to amount requested:



You will receive an AUTHORISATION webhook after the shopper completes the payment in their ANCV app:


With partial authorisation the possibility exists that if the amount authorised by the shopper is less than the amount requested by the merchant, only the requested amount displays in Customer Area. However, the correct authorised amount reflects in the /payments/details response and the AUTHORISATION webhook notification. In both the /payments/details response and the AUTHORISATION webhook, you will receive the authorised amount in additionalData.authorisedAmountValue.

Test and go live

  1. Test your integration end-to-end with the ANCV test app. Instructions on how to download, install and onboard ANCV users, as well as the required test credentials, are shared by ANCV directly with the merchant.
  2. Make sure to test ANCV payments with partial payments.
  3. Add ANCV in your live Customer Area and provide the Merchant ID (shopID in ANCV vocabulary), as received from ANCV.

See also