getPaymentInfo()


This API call is used to get a payment details.


Trusted mode requires i_wholesaler parameter to be supplied to identify the caller.


Note! Either i_account or i_customer is to be supplied.


Parameters:

  • i_account - i_account of account that made the payment. Integer. Required.
  • i_customer - i_customer of customer that made the payment. Integer. Required.
  • i_payment - i_payment reference returned by makePayment(). Integer. Required.

Returns:

  • result - OK. String.
  • payment_time - time of the payment in '%H:%M:%S.000 GMT %a %b %d %Y' format (e.g. 09:57:29.000 GMT Wed Nov 18 2009). String.
  • amount - payment amount. Double.
  • currency - payer base currency. Double.
  • tx_id - transaction ID returned by payment processor. String.
  • tx_error - error returned by payment processor. String.
  • tx_result - transaction result. Integer. Possible values:
    • 1 - successfull payment
    • 2 - failed payment
  • by_credit_debit_card - the payment was made using credit/debit card via payment processor. Boolean.
  • by_voucher - the payment was made using top-up voucher. Boolean.
  • notes - payment notes. String.
  • XMLRPC fault in case of any error.

getPaymentsList()


This API call is used to get a list of payments.


Trusted mode requires i_wholesaler parameter to be supplied to identify the caller.


Parameters:

  • i_account - i_account of account that made the payment. Integer. Optional.
  • i_customer - i_customer of customer that made the payment. Integer. Optional.
  • offset - skip fist offset CDRs. Integer. Optional.
  • limit - return only limit CDRs. Integer. Optional.
  • start_date - fetch payments from start_date, format is '%H:%M:%S.000 GMT %a %b %d %Y' (e.g. 09:57:29.000 GMT Wed Nov 18 2009). String. Optional.
  • end_date - fetch payments till end_date, format is '%H:%M:%S.000 GMT %a %b %d %Y' (e.g. 09:57:29.000 GMT Wed Nov 18 2009). String. Optional.
  • type - type of payment. String. Optional. Possible values:
    • credit - return only credit payments
    • debit - return only debit payments

Returns:

  • result - OK. String.
  • payments - an array containing structures:
    • payment_time - time of the payment in '%H:%M:%S.000 GMT %a %b %d %Y' format (e.g. 09:57:29.000 GMT Wed Nov 18 2009). String.
    • amount - payment amount. Double.
    • currency - payer base currency. Double.
    • i_payment - internal transaction ID. Integer.
    • tx_id - transaction ID returned by payment processor. String.
    • tx_error - error returned by payment processor. String.
    • tx_result - transaction result. Integer. Possible values:
      • 1 - successfull payment
      • 2 - failed payment
    • i_account - i_account of account that made the payment. Integer.
    • i_customer - i_customer of customer that made the payment. Integer.
    • by_credit_debit_card - the payment was made using credit/debit card via payment processor. Boolean.
    • by_voucher - the payment was made using top-up voucher. Boolean.
    • notes - payment notes. String.
  • XMLRPC fault in case of any error.