Status Retrievals (LEGACY)

Parameters

When calling the exchange / communication URL, PAY. includes a number of POST / GET parameters.

Example exchange call
https://www.domain.com/exchange/?action=pending&order_id=819034534X2b5a00&payment_session_id=819034534&ip_address=1.2.3.4amount=9.99&extra1=order%20123&extra2=klant%20123&extra3=factuur%20123&info=facebook_campaign

The actual call may include more parameters, depending on the selected payment option.

Request calls

The exchange call is invoked when the status of a transaction changes. The moment of invocation is indicated by the 'action' variable. This can vary per payment option and is shown below.

Required response

To verify whether a request was received properly, we expect a response for your server in the TXT format. This response must consist of the word TRUE. If the correct response is not received, PAY. will consider the call failed and the retry scheme will be initiated (if one was set up).

HTTP status code must be 200 for a correct Exchange call, if we receive any other result, we mark the request as failed an the retry sceme will resend the request.

Processing exchange call

It is essential that you process the transaction via the exchange URL, not via the return URL. Not every customer reaches the return URL, because some people close the payment screen immediately after completing the payment. The return URL is therefore only intended to let customers know whether their payment was successful.

Contrary to the return URL, the exchange URL is always called. This is therefore where you can process orders in your back office, e.g. by updating its status in your database, sending an invoice or email, et cetera.

Verifying status
You should always verify the status of a transaction using the order_id parameter, just like in the PHP code example. Do not use the action parameter to determine the transaction’s status, as it may have been changed manually in the URL.

📘

Exchange timing

With many payment methods, the exchange URL is called in the Payment process. If the exchange response within the MAX-exhange-timeout, your platform will know the status before the user get's back on the Return URL. If you fail to respond within 5seconds, we transfer the user back to your shop, and retry the call via the selected retry sceme.

<?php 
# Setup API Url
$strUrl = "https://rest-api.pay.nl/v7/Transaction/info/array_serialize?"; 

# Add arguments
$arrArguments = array();
$arrArguments['transactionId'] = filter_var(
$_GET['order_id']);

# Prepare complete API URL
$strUrl = $strUrl . http_build_query($arrArguments);
$objCurl = curl_init($strUrl);
curl_setopt($objCurl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($objCurl, CURLOPT_USERAGENT, "Pay.nl 
Api Example");
curl_setopt($objCurl, CURLOPT_TIMEOUT, 5
);
curl_setopt($objCurl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($objCurl, "AT-XXXX-XXXX:<your-api-token>");
$strReturnData = curl_exec($objCurl);
curl_close($objCurl);

# Process result
$strMessage = '';
$arrResult = unserialize($strReturnData);
if(isset($arrResult['paymentDetails']['stateName'])) {

    if($arrResult['paymentDetails']['stateName'
] == 'PAID') {
        # Execute code to process the order       

        $strMessage = 'Order processed';
    }
    elseif($arrResult['paymentDetails']['stateName'] == 'CANCEL') {
        # Payment canceled, restock items

        $strMessage = 'Order canceled';
    }
}

echo 'TRUE|'.$strMessage;

Multicore

If you use the multicore, and you do not store the used core endpoint, you can calculate the Core Endpoint based on the generated orderID