Processing e-Chèque-Vacances payment response-specific data

Features of a split payment:

  • All the transactions of a split payment are combined within a payment sequence.
  • All the transactions of a payment sequence have the same transaction identifier, but a different sequence number.
  • The number of the first transaction of the sequence is 1, the number of the second is 2, etc.

Context:

When paying, the buyer pays for a part of the purchase with a e-Chèque-Vacances card and the rest with a bank card.

The payment will consist of N sequences detailed in the vads_payment_seq field:

Note: There are as many E_CV transactions as submitted checks, plus one transaction for the bank card.

The Instant Payment Notification URL will contain the following information:

Field name Description Value
vads_page_action Completed operation

PAYMENT

Payment made without token

vads_trans_status Status of the payment

The returned status is based on the terms of payment.

  • If the payment was made only with e-Chèque-Vacances:

    The value is CAPTURED (Sent).

    The "e-Chèques-Vacances" are validated in real time by the ANCV server.

  • If the payment is completed by another payment methods, the value of the status is that of the supplement.
    • Payment card without capture delay

      The possible values are:

      AUTHORISED

      Accepted, waiting for capture

      CAPTURED

      Sent

    • Payment card with capture delay greater than 0 days or requiring action by the merchant:

      The possible values are:

      WAITING_AUTHORISATION

      Waiting for authorization

      WAITING_AUTHORISATION_TO_VALIDATE

      To be validated and authorized

      AUTHORISED_TO_VALIDATE

      To be validated and authorized

  • If the payment has not been made, the possible values are:
    • ABANDONED

      payment abandoned by the buyer.

      The transaction has not been created, and therefore cannot be viewed in the Merchant Back Office.

    • REFUSED

      Transaction is declined.

    • EXPIRED
      Expired

      The expiry date of the authorization request has passed and the merchant has not validated the transaction. The account of the cardholder will, therefore, not be debited.

    • CANCELLED
      Payment canceled by the merchant
vads_card_brand Payment type Case of payment made using only a "e-Chèques-Vacances"
  • "E_CV"

Case of a split payment (a "e-Chèques-Vacances" and a complementary payment method):

  • MULTI
    The table of payment methods used by the buyer can be found in the JSON of the vads_payment_seq field (card_brand element).
vads_payment_seq Details of the split payment sequence See explanations and table below.

Details of the vads_payment_seq field

All the transactions of a split payment are combined within a payment sequence.

All the transactions of a payment sequence have the same transaction identifier, but a different sequence number. The number of the first transaction of the sequence is 1, the number of the second is 2, etc.

The vads_payment_seq field (json format) describes the split payment sequence. It contains:

  • "trans_id": identifier of the transaction received in the vads_trans_id field of the payment form.
  • "transaction" : transaction table of the sequence.

Note: canceled transactions are also mentioned in the table.

Each transaction of the sequence contains the following elements:

Table 1. JSON object content
Field name Description
amount

Amount of the payment sequence.

operation_type

Debit transaction.

auth_number

Authorization number. Example: 949478

This parameter is returned empty for payments by "e-Chèque-Vacances". It is not provided by the ANCV server. Authorization number returned by the authorization server, if available (otherwise, empty).

auth_result Return code of the authorization request.
capture_delay Delay before the capture (in days).
  • For payments by "e-Chèques-Vacances", this parameter is set to"0". The "e-Chèques-Vacances" are validated in real time.
  • For a payment by card, this parameter is the requested capture date (ISO 8601 format). If not sent in the payment form, the value defined in the Merchant Back Office will be used.
card_brand

Used payment method.

For payments by "e-Chèques-Vacances", this parameter is set to"E_CV".

For a payment by card (e.g. CB or Visa or MasterCard co-branded CB cards), this parameter is set to "CB".

See the Payment Gateway Implementation Guide available in our online documentation archive to see the complete list of card types.

card_number

Payment method number

  • For a payment by "e-Chèques-Vacances", this parameter is populated by concatenating as follows: the check number - the organization number - the issue year. The values should be separated with a "-".
  • For payments by credit cards, the number is masked.
expiry_month

Expiry month of the payment method

This field is not sent for payments by e-Chèque-Vacances.

expiry_year

Expiry year of the payment method

This field is not sent for payments by e-Chèque-Vacances.

payment_certificate Payment certificate.
contract_used Contract used for the payment
identifier Unique identifier (token) associated with a payment method.
identifier_status Only present if the requested action is a token creation or update.
Possible values:
Value Description
CREATED

The authorization request has been accepted.

Token (or UMR for SEPA payment) has been successfully created.

NOT_CREATED

The authorization request has been declined.

The token (or UMR for SEPA payment) has not been created, and therefore cannot be viewed in the Merchant Back Office.

UPDATED Token (or UMR for SEPA payment) has been successfully updated.
NOT_UPDATED The token (or UMR for SEPA payment) has not been updated.
ABANDONED

The action has been abandoned by the buyer (debtor).

The token (or UMR for SEPA payment) has not been created, and therefore cannot be viewed in the Merchant Back Office.

presentation_date

For a payments by card, this parameter is the requested capture date (ISO 8601 format).

For a payment by e-Chèques-Vacances, this parameter corresponds to the date of the order. The e-Chèques-Vacances are validated in real time by the ANCV server.

trans_id Transaction number.
ext_trans_id

This field is not sent for payments by credit cards.

For a payment by e-Chèques-Vacances, this parameter is populated by the payment gateway (transaction reference).

trans_uuid Unique reference generated by the payment gateway after the creation of a payment transaction.

Guarantees that each transaction is unique.

extra_result Numeric code of the risk controls result.
Code Description
Empty No verification completed.
00 All the verification processes have been successfully completed.
02 Credit card velocity exceeded.
03 The card is in the merchant's greylist.
04 The country of origin of the card is on the merchant's greylist.
05 The IP address is on the merchant's greylist.
06 The BIN code is on the merchant's greylist..
07 Detection of an e-carte bleue.
08 Detection of a national commercial card.
09 Detection of a foreign commercial card.
14 Detection of a card that requires systematic authorization.
20 Relevance verification: countries do not match (country IP address, card country, buyer's country).
30 The country of the this IP address belongs to the greylist.
99 Technical issue encountered by the server during a local verification process.
sequence_number Sequence number.
trans_status Transaction status.

Example of vads_payment_seq field values

  • Case 1: all the submitted e-Chèques-Vacances have been added and validated
vads_payment_seq :{
	"trans_id":"913509",
	"transactions": [
	{
		"amount":"6000",
		"operation_type":"DEBIT",
		"auth_number":"",
		"capture_delay":"0",
		"card_brand":"E_CV",
		"card_number":"2002-838861-2015",
		"payment_certificate":"d396a0a9601dc88d23bba2224a41fe8c32676e2f",
		"presentation_date":"2015-02-18T16:12:01Z",
		"trans_id":"913509",
		"ext_trans_id":"87c092a8403747cb9b1486cfa34c3dcc",
		"sequence_number":"1",
		"trans_status":"CAPTURED"		
	},
{
		"amount":"6000",
		"operation_type":"DEBIT",
		"auth_number":"",
		"capture_delay":"0",
		"card_brand":"E_CV",
		"card_number":"2004-838861-2015",
		"payment_certificate":"d396a0a9601dc88d23bba2224a41fe8c32676e2f",
		"presentation_date":"2015-02-18T16:12:01Z",
		"trans_id":"913509",
		"ext_trans_id":"87c092a8403747cb9b1486cfa34c3dcc",
		"sequence_number":"2",
		"trans_status":"CAPTURED"		
	},
{
		"amount":"5800",
		"operation_type":"DEBIT",
		"auth_number":"3fec1e",
		"capture_delay":"0",
		"card_brand":"CB",
		"card_number":"497010XXXXXX0000",
		"expiry_month":"6",
		"expiry_year":"2016",
		"payment_certificate":"010a2db1ef864d6584424c41512dd9ad678c785e",
		"presentation_date":"2015-02-18T16:12:13Z",
		"trans_id":"913509",
		"sequence_number":"3",
		"trans_status":"AUTHORISED"
	}
	]
}

  • Case 2: the buyer cancels a submitted e-Chèque-Vacance
    Unlike in case 1, the value of the field "trans_status" is set to CANCELLED to indicate the cancellation of the e-Chèque-Vacance by the buyer.
    vads_payment_seq :"trans_id":"913509",
    	"transactions": [
    	{
    		"amount":"6000",
    		"operation_type":"DEBIT",
    		"auth_number":"",
    		"capture_delay":"0",
    		"card_brand":"E_CV",
    		"card_number":"2002-838861-2015",
    		"payment_certificate":"d396a0a9601dc88d23bba2224a41fe8c32676e2f",
    		"presentation_date":"2015-02-18T16:12:01Z",
    		"trans_id":"913509",
    		"ext_trans_id":"87c092a8403747cb9b1486cfa34c3dcc",
    		"sequence_number":"1",
    		"trans_status":"CANCELLED"		
    	},
    {
    		"amount":"6000",
    		"operation_type":"DEBIT",
    		"auth_number":"",
    		"capture_delay":"0",
    		"card_brand":"E_CV",
    		"card_number":"2004-838861-2015",
    		"payment_certificate":"d396a0a9601dc88d23bba2224a41fe8c32676e2f",
    		"presentation_date":"2015-02-18T16:12:01Z",
    		"trans_id":"913509",
    		"ext_trans_id":"87c092a8403747cb9b1486cfa34c3dcc",
    		"sequence_number":"2",
    		"trans_status":"CAPTURED"		
    	},
    {
    		"amount":"11800",
    		"operation_type":"DEBIT",
    		"auth_number":"3fec1e",
    		"capture_delay":"0",
    		"card_brand":"CB",
    		"card_number":"497010XXXXXX0000",
    		"expiry_month":"6",
    		"expiry_year":"2016",
    		"payment_certificate":"010a2db1ef864d6584424c41512dd9ad678c785e",
    		"presentation_date":"2015-02-18T16:12:13Z",
    		"trans_id":"913509",
    		"sequence_number":"3",
    		"trans_status":"AUTHORISED"
    	}
    	]
    }

Notes:

  • If the payment by bank card is rejected, the value of the "trans_status" field is set to REFUSED.

    The payment gateway cancels the reservation of e-Chèques-Vacances on the ANCV server and the payment is canceled in its entirety.

  • If the payment by bank card is accepted, the value of the field "trans_status" is set to AUTHORISED.

    The payment gateway definitively validates the reservation of e-Chèques-Vacances on the ANCV server. The payment by e-Chèques-Vacances and bank card is validated.