Processing the response data
Here is an example of analysis to guide you through processing the response data.
- Identify the order by retrieving the value of vads_order_id if you have provided it in
the payment form. Make sure that the order status has not been updated yet.
- Retrieve the payment result transmitted in the field vads_trans_status. Its value allows you to define the order status.
VALUE DESCRIPTION AUTHORISED Waiting for capture
The merchant has requested the creation of a deferred payment or an token or recurring payment.
Specific to payments by token and recurring payments. This status is temporary and does not indicate that the transaction will be accepted.At the time of capture, the transaction is in the “Captured transactions” tab of the Merchant Back Office with the status “Capture in progress”. It is being validated byPaypal.
- IfPaypalaccepts the transaction, the final status is CAPTURED, visible in the “Captured transactions” tab of the Merchant Back Office with the “presented” status.
- IfPaypalrefuses the transaction, the final status is CAPTURE_FAILED, visible in the “Captured transactions” tab of the Merchant Back Office with the “malfunction” status.
To be notified, the merchant must imperatively configure the notification rule "Instant Payment Notification URL on batch change" (see Setting up a notification on batch change chapter).
AUTHORISED_TO_VALIDATE To be validated The transaction, created with manual validation, is authorized. The Merchant must manually validate the transaction in order for it to be captured.
The transaction can be validated as long as the expiration date of the authorization request has not passed. If the authorization validity period has passed, the payment status changes to EXPIRED. The Expired status is final.
CANCELLED Canceled
The payment has been canceled by the merchant.
CAPTURED Captured
The merchant has requested the creation of an immediate payment.
The transaction has been captured by the bank.
CAPTURE_FAILED Capture failed
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.
REFUSED Refused
The transaction is refused.
See the following chapter to obtain more information on the rejected payment.
UNDER_VERIFICATION Control in progress
PayPalretains the transaction because of suspected fraud.
The payment will remain in the Transactions is progress tab until the verification process has been completed.
The transaction will then take one of the following statuses:AUTHORISEDorREFUSED.
A notification will be sent to the Merchant to warn them about the status change (Instant Payment Notification on batch change).
WAITING_AUTHORISATION Waiting for authorization The merchant has requested the creation of a payment deferred by more than 3 days.
WAITING_AUTHORISATION_TO_VALIDATE To be validated and authorized The payment is waiting for validation by the merchant.
3 days prior to the capture date, and without validation by the merchant, the status will automatically become To be validated
or Declined (depending on the authorization result). - If the payment is refused, you can check if the error is
explained in the field vads_payment_error.
Value Description 75 The operation was declined by PayPal. 88 Refund error: PayPal does not allow transaction refunds after 60 days. 173 Error within the Express Checkout PayPal service. Possible reason: Restricted Account.
If your PayPal account is restricted, sign in to your Resolution center on the PayPal website.
- Retrieve the field vads_trans_uuidcontaining the unique reference of the transaction generated by the payment server.
- Retrieve the PayPal transaction reference transmitted in the field vads_ext_trans_id.
- Retrieve the value of the field vads_trans_dateto identify the payment date.
- Retrieve the used amount and currency. To do this, retrieve the values of the following fields:
Field name Description vads_amount Payment amount in the smallest currency unit. vads_currency Numeric code of the currency used for the payment. vads_change_rate Exchange rate used for calculating the effective payment amount (seevads_effective_amount). vads_effective_amount Payment amount in the currency used for the capture in the bank. vads_effective_currency Numeric code of the currency that will be used for the capture at the bank. - Retrieve the payment method data used for the payment by analyzing the following fields:
Field name Description vads_card_brand Payment method. Set to PAYPAL. vads_acquirer_network Acquirer network. Set to: - PAYPAL: for a production payment
- PAYPAL_SB: for a test payment
- Retrieve all the order, buyer and shipping details. These details will be provided in the response only of they have been transmitted in the payment form. Their values are identical to the ones submitted in the form.
- Save the value of the field vads_authent_paypal_protection_eligibilityto identify the type of
protection used for the transaction. Three values are possible:
- ELIGIBLE
Merchant is protected by PayPal's Seller Protection Policy for unauthorized payments and Item Not Received.
- PARTIALLY_ELIGIBLE
Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
- INELIGIBLE
Merchant is not protected by PayPal's Seller Protection Policy for Item Not Received.
- ELIGIBLE
- Proceed to order update.