Retrieve check payment details

Retrieve the check payment details that customers must use or have used to pay for an order.

Request 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.

Request sample

<?php

require ('PATH_TO_AUTH');  // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/02Authentication
require ('PATH_TO_setPartner'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/Partner/00Set_partner

$proformaNumber = 'YOUR_PROFORMA_NUMBER';

$jsonRpcRequest = array (
  'jsonrpc' => '2.0',
  'id' => $i++,
  'method' => 'setProforma',
  'params' => array($sessionID, $proformaNumber)
);
var_dump (callRPC((Object)$jsonRpcRequest,$host));

$paymentDetails = new stdClass();
$paymentDetails->Type = 'CHECK';
$paymentDetails->Curency = 'USD';

$jsonRpcRequest = array (
  'jsonrpc' => '2.0',
  'id' => $i++,
  'method' => 'setPaymentDetails',
  'params' => array($sessionID, $paymentDetails)
);
var_dump (callRPC((Object)$jsonRpcRequest,$host));

$jsonRpcRequest = array (
  'jsonrpc' => '2.0',
  'id' => $i++,
  'method' => 'payProforma',
  'params' => array($sessionID)
);
var_dump (callRPC((Object)$jsonRpcRequest,$host));

$refNo = 'YOUR_ORDER_REFERENCE_NUMBER';

$jsonRpcRequest = array (
  'jsonrpc' => '2.0',
  'id' => $i++,
  'method' => 'getCheckPaymentDetails',
  'params' => array($sessionID, $refNo)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));

Response parameters

Parameter	Type / Description
CheckPaymentDetails	Object Details below
CheckPaymentDetails.Beneficiary	String Payment beneficiary name. Can be NULL.
CheckPaymentDetails.CheckPostalAddress	String Beneficiary address. Can be NULL.
CheckPaymentDetails.CheckAccountHolderName	String Beneficiary account holder name. Can be NULL.
CheckPaymentDetails.Country	String Beneficiary country. Can be NULL.
CheckPaymentDetails.Amount	Double Total order costs. Can be NULL.
CheckPaymentDetails.Currency	String Order currency ISO code – ISO 4217. Can be NULL.

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.