Retrieve check payment details
Overview
Retrieve the check payment details that customers must use or have used to pay for an order.
Requirements
This method requires you to set a specific partner using setPartner.
Next, use setProforma to identify a specific partner invoice.
Parameters
Parameter | Type/Description |
---|---|
sessionID | Required (String) |
Session identifier string, output of the Login method. An exception is thrown if the values are incorrect. | |
refNo | Required (String) |
Order reference number of an order that was marked with CHECK as payment method. |
Response
Parameter | Type/Description | |
---|---|---|
CheckPaymentDetails |
Object |
|
|
Details below |
|
|
Beneficiary |
String |
|
|
Payment beneficiary name. Can be NULL. |
|
CheckPostalAddress |
String |
|
|
Beneficiary address. Can be NULL. |
|
CheckAccountHolderName |
String |
|
|
Beneficiary account holder name. Can be NULL. |
|
Country |
String |
|
|
Beneficiary country. Can be NULL. |
|
Amount |
Double |
|
|
Total order costs. Can be NULL. |
|
Currency |
String |
|
|
Order currency ISO code – ISO 4217. Can be NULL. |
Request
<?php require('PATH_TO_AUTH'); // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/02Authentication require('PATH_TO_setPartner'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/06Reference/Partner/00Set_partner $proformaNumber = 'YOUR_PROFORMA_NUMBER'; try { $Proforma= $client->setProforma ($sessionID, $proformaNumber); } catch (SoapFault $e) { echo "ProformaOutput: " . $e->getMessage(); exit; } var_dump ("ProformaOutput", $Proforma); $paymentDetails = new stdClass(); $paymentDetails->Type = 'CHECK'; $paymentDetails->Curency = 'YOUR_CURRENCY'; $paymentDetails->CustomerIP = 'CUSTOMER_IP'; try { $PaymentDetailsSet= $client->setPaymentDetails($sessionID, $paymentDetails); } catch (SoapFault $e) { Echo "Payment: " . $e->getMessage(); exit; } var_dump ("Payment", $PaymentDetailsSet); try { $ProformaPay= $client->payProforma($sessionID); } catch (SoapFault $e) { Echo "ProformaPaid: " . $e->getMessage(); exit; } var_dump ("ProformaPaid ", $ProformaPay); $refNo = 'YOUR_ORDER_REFNO' try { $client->getCheckPaymentDetails ($sessionID, $refNo); } catch (SoapFault $e) { echo "Error: " . $e->getMessage(); }
Errors
Error | Description |
---|---|
INVALID_PARTNER |
No partner is set. |
PAYMENT_PROFORMA |
You have to set a partner invoice first. |
PAYMENT_NOT_SUPPORTED |
The current partner invoice is not set as payable through check. |