Payment-method icon

ANCV for API only

Add ANCV to your API-only integration.

You can add ANCV to your existing integration. The following instructions show only what you must add to your integration specifically for ANCV.

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.

Requirements

Requirement Description
Integration type Make sure that you have an existing API-only integration.
Action handling Make sure that your existing integration is set up to handle the additional action.
action.type: await.
Setup steps Before you begin, add ANCV in your Customer Area.

How it works

  1. The shopper selects ANCV as the payment method.
  2. The shopper enters their details in the payment form that you build.
  3. When you make the payment request, you include additional information about the items that the shopper intends to purchase.
  4. Your existing integration setup will handle the await action, while you display the waiting screen.

Build your payment form

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.

You can download the logo for ANCV to use in your form.

Get ANCV as an available payment method

When you make the /paymentMethods to get available payment methods, specify the following so that ANCV is included in the response.

Parameter Values
countryCode FR
amount.currency EUR

Add additional parameters to your /payments request

When you make a payment, add the following parameters:

Parameter Required Description
paymentMethod.type -white_check_mark- ancv
paymentMethod.beneficiaryId -white_check_mark- This is the ANCV ID of the shopper collected during the checkout (either email address or 11-digit value).

The response includes:

  • action.type: await
  • 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 it is possible that if the amount authorized by the shopper is less than the amount requested by the merchant, the Customer Area only shows the requested amount. However, the correct authorized amount is shown in the /payments/details response and in the AUTHORISATION webhook, 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