Analyzing the result of a cascading payment
Characteristics of a cascading payment:
When making a payment, the buyer pays a part of the purchase with Titre-Restaurant and the remaining amount with another payment method.
The payment will consist of N sequences detailed in the vads_payment_seq field:
- All the transactions of a cascading 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 one is 2, etc.
How to identify a cascading payment?
In case of a cascading payment, the vads_card_brand field is set to MULTI.
Details of the vads_payment_seq field
All the transactions of a cascading 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 one is 2, etc.
The vads_payment_seq field (JSON format) describes the cascading payment sequence. It contains the following elements:
- “trans_id”: identifier of the transaction received in the vads_trans_id field of the payment form.
- “transactions”: table of sequence transactions.
Each transaction of the sequence contains the following elements:
| Field name | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| amount | Amount of the payment sequence. | ||||||||||||
| operation_type | Debit transaction. | ||||||||||||
| auth_number | Authorization number. Will not be returned if not applicable to the used payment method. Example: 949478 | ||||||||||||
| auth_result | Return code of the authorization request.
| ||||||||||||
| capture_delay | Delay before the capture (in days). If the vads_capture_delay field is not transmitted in the payment request, the delay configured in shop settings will be applied. See the chapter Technical information to check if any restrictions apply for this payment method. | ||||||||||||
| card_brand | Code of the used payment method. Examples:
See Hosted Payment Page Implementation Guide to view the full list of vads_card_brand field values. | ||||||||||||
| card_number | Payment method number or ID of the account used for the payment. | ||||||||||||
| expiry_month | Expiry month of the payment method. Will not be returned if not applicable to the used payment method. | ||||||||||||
| expiry_year | Expiry year of the payment method. Will not be returned if not applicable to the used payment method. | ||||||||||||
| payment_certificate | Payment certificate. Will not be returned if not applicable to the used payment method. | ||||||||||||
| contract_used | Contract number used for the payment. | ||||||||||||
| identifier | Token associated with a payment method. Will not be returned if not applicable to the used payment method. | ||||||||||||
| identifier_status | Only present if the requested action is a token creation or update. Possible values:
| ||||||||||||
| presentation_date | Desired date of capture at the bank (in ISO-8601 format). Example: 2020-04-08T14:56:48Z | ||||||||||||
| trans_id | Transaction number. | ||||||||||||
| ext_trans_id | Transaction reference on the acquirer side. Will not be returned if not applicable to the used payment method. | ||||||||||||
| trans_uuid | Unique reference generated by the payment gateway after the creation of a payment transaction. Guarantees that each transaction is unique. | ||||||||||||
| sequence_number | Sequence number. | ||||||||||||
| trans_status | Status of the transaction.
| ||||||||||||
| extra_result | Numeric code of the risk assessment result. Will not be returned if not applicable to the used payment method. See Hosted Payment Page Implementation Guide to view the full list of vads_extra_result field values. |