PayPost-v5 Pre-Auth Transaction Processing

Pre-Authorisation allows for post actions to be performed on authorised transactions before they are settled. Your account will be configured to capture the authorisation only. Subsequently one of the following occurs:

  1. A completion request is sent.
  2. A cancellation request is sent.

When dealing with pre-auth transactions it is important to be aware that the amount pre-authorised is reserved against the card holder's card until settled. Some card providers may provide live information to the card holder showing that this amount is reserved which may be misunderstood as a payment.

Completion Process

A completion request is provided to confirm that you wish the transaction to be settled. This request can contain a final amount for the transaction which is different to the original authorisation amount. This may be useful in a delayed system process such as waiting for stock to be ordered, confirmed, or services provided before the final cost is known.

When a transaction is completed, a new authorisation code is created and a confirmation is sent to the acquiring bank online in real time.

To create a completion request, a HHTP Post request should be sent forwarded to the URL https://secure.citypay.com/ecom/Complete  with the following parameters.

Parameter

Type

Requirement

Description

merchantid

Integer

Required

The merchant id the original transaction was processed using

licencekey

String

Required

The merchant licence key for your installation

identifier

String

Optional

The identifier of the transaction to look up and complete. If an empty value is supplied then a transno value must be supplied.

transno

Integer

Optional

The transaction number of the transaction to look up and complete. If an empty value is supplied then an identifier value must be supplied.

amount

Integer

Required

The completion amount provided in the lowest unit of currency for the specific currency of the merchant, with a variable length to a maximum of 12 digits. No decimal points to be included. For example with GBP 75.45 insert amount=7545. Please check that you do not supply divisional characters such as 1,024 in the request which may be caused by some number formatters. 


Once the transaction has been processes. A standard response will be returned, outlining the result of the transaction. On a successful completion, the transaction will be queued for the next available settlement run.

Cancellation Process

A cancellation request is provided to cancel a transaction from being settled. A cancellation will be performed online with the acquiring bank to confirm that the transaction can be canceled. If a transaction has already been completed, canceled or auto expired, this process may not be performed. Appropriate error messages will be returned in the response document to reflect this.

To create a cancellation request, a HTTP Post request should be sent to https://secure.citypay.com/ecom/Cancel using the following parameters.

Parameter

Type

Requirement

Description

merchantid

Integer

Required

The merchant id the transaction was processed using

licencekey

String

Required

The merchant licence key for your installation

identifier

String

Optional

The identifier of the transaction to look up and complete. If an empty value is supplied then a transno value must be supplied.

transno

Integer

Optional

The transaction number of the transaction to look up and complete. If an empty value is supplied then an identifier value must be supplied.

Once the transaction has been processes. A  standard response  will be returned, outlining the result of the transaction. 

Retention Period for Open Transactions

Please note that transactions will remain in an open state and it is the responsibility of the Merchant to complete or cancel all transactions processed using the pre-auth facility.

 

+44 (0)1534 884000