Receiving the Payment Receipt

Payment receipt includes fields defined in PARAMS_OUT. Receipt always includes values PAYMENT_ID, TIMESTAMP, STATUS and RETURN_AUTHCODE.

After the payment has been successfully completed, the customer is redirected to the URL defined in the previous stage (URL_SUCCESS). If the payment was cancelled, the customer is directed to the cancelled payment URL (URL_CANCEL).

The notification address (URL_NOTIFY) is called when Paytrail marks the payment as completed. Typically this happens within a few minutes after redirecting the customer to URL_SUCCESS. Note that in some rare cases URL_NOTIFY is called before the customer is redirected to URL_SUCCESS. URL_NOTIFY call includes parameters defined in PARAMS_OUT_NOTIFY. The received notification must be acknowledged by responding with an HTTP status in the 200-299 range.

Please note that it is possible that URL_SUCCESS and/or URL_NOTIFY are called for a payment after URL_CANCEL has been called. Thus, a call to URL_CANCEL should not delete the order, or place it into a status that can not be changed to paid if a call is made to URL_SUCCESS or URL_NOTIFY.

If the customer does not return to Paytrail’s service from the payment method provider’s service, the information on successful payment will not be immediately available. In this case URL_NOTIFY will be called immediately when that information has arrived. We use payment status query services provided by payment method providers to speed up the process of the payment being marked as completed. When we receive information on the payment being completed, the notification address is called.

In cases where payment method provider does not provide payment status query service, information about completed payment arrives on the next banking day. The only payment method provider currently not providing payment status query service is Ã…landsbanken.

The receipt carries unique return information that is used to verify the validity of the receipt and that the payment was actually successful. Return authentication AUTHCODE is compared to the hash calculated and if the values match, the payment receipt was not tampered.

In RETURN_AUTHCODE calculation, fields are joined using the | character (pipe, vertical bar) as separator. Authcode calculation fields are joined in the order defined in PARAMS_OUT field. Merchant hash is appended to the string.

Fields for the Receipt

ORDER_NUMBER

This is the same order number that was sent to the Payment Gateway.

PAYMENT_ID

Unique ID for payment. Value is always included.

AMOUNT

Payment total. AMOUNT equals the value provided in payment creation.

CURRENCY

Currency.

PAYMENT_METHOD

Payment method which was selected at payment method page (or preselected with value PAYMENT_METHODS). Value is empty if no payment method has been selected.

TIMESTAMP

Timestamp generated by the Payment Gateway that is used to calculate the return authentication hash. Timestamp is in UNIX format, i.e. seconds from 1st Jan 1970. Value is always included.

STATUS

It is used to verify the validity of a successful payment. Possible values are PAID and CANCELLED.

SETTLEMENT_REFERENCE_NUMBER

This is the same reference number that was sent to the Payment Gateway or the reference number generated by Paytrail.

RETURN_AUTHCODE

If the value matches the calculated one, the payment has been completed and the information has not been modified after sending. Value is always included.