paymentRequest

The paymentRequest object allows to transmit the information related to the payment.

It has the following attributes:

Attribute Required Format
transactionId

Transaction reference when creating or updating a payment transaction.

Its value is unique on a given day.

  • This identifier can either be generated by the gateway. In this case, this parameter is not required.
  • Or by the merchant website. In this case, this parameter is required with the desired value of the identifier. Warning, the merchant website must make sure that the identifiers are unique. Any registration request containing an existing identifier will be rejected and will provoke the error message 12.

    Note: this attribute cannot be submitted empty.

  an..6
amount

Transaction amount in the smallest currency unit (cents for euro).

Note:

  • Must not be submitted empty or be equal to 0.
  • Must not exceed the initial amount (example: refund).
n..12
currency

Currency code of the transaction (ISO 4217 standard).

E.g.: 978 for euro (EUR)

n3
expectedCaptureDate

Requested capture date in ISO 8601 format defined by W3C.

E.g.: 2016-07-16T19:20:00Z.

This parameter is used for making deferred payments.

If the number of days between the requested capture date and the current date is greater than the authorization validity period, an authorization for 1 EUR (or information request about the CB network if the acquirer supports it) will be made on the day of the transaction. This will be done to verify that the card validity.

The authorization for the total amount will be made:

  • by default: on the desired capture day,
  • case of anticipated authorization: depending on the chosen payment method, D- the number of days corresponding to the authorization validity period before the desired capture date in the bank.

If you wish to be notified about the result of this authorization request, configure the Notification URL upon Batch authorization notification rule in the Expert Back Office (Settings > Notification rules).

Note: if the capture delay is higher than 365 days in the payment request, it will be automatically reset to 365 days.

  dateTime ans..40
manualValidation

Allows to manually validate a transaction until the desired bank capture date is not exceeded.

To do so, this attribute must be set to 1 (manual validation).

If it is set to 0, validation will be automatic.

  n1