PaymentInfoGet_API

Syntax

BM :: PaymentInfoGet_API (

  Int DocID.

)

returns

  Int DocID;

  Str DocNum;

  Int DocType;

  Int Status;

  Str CurrencyID;

  Double Total; 

  Double TaxTotal;

  Double DocBBalance;

  Double AvailBal;

  Int Vendor_AccountID;

  Int Customer_AccountID;

  Int Crtd_DateTime;

  Int Crtd_User_UsersID;

  Int DocDate;

  Str Description;

  Str BranchID;

  Str SalesID;

  Int PayToolID;

  Int ETransStatus;

  Str FromIP;

  Str AuthCode;

  Str TrNumber;

  Int PTransActivityID;

  Int Benef_AccountID;

  Int PluginID;

  Int ChrgAttempts;

  Int PayToolType.

Parameters Description

Input parameter:

Int DocID – Identifier of the payment document the details for which are to be displayed.

Output parameters:

• Int DocID – Identifier of the payment document.
• Str DocNum – Number of the document.
• Int DocType – Type of the document. The meanings of the type value are as follows:
  • 50 – Payment
  • 70 – Refund
• Int Status – Status of the document. The status possible values are:
  • 1000 – Open
  • 2000 – Hold
  • 3000 – Closed
  • 4000 – Voided
  • 5000 – Refunded
  • 6000 – Cancelled
  • 7000 – Delayed
• Str CurrencyID – Identifier of the currency used for payment.
• Double Total- Total purchase sum specified in the document.
• Double TaxTotal-- Total Tax sum specified in the document. The value of this field is null because this parameter is not applicable to the payment and refund document types.
• Double DocBBalance- Accounting Balance specified in the document.
• Double AvailBal- Available Balance specified in the document.
• Int Vendor_AccountID- Identifier of the vendor account.
• Int Customer_AccountID- Identifier of the customer account.
• Int Crtd_DateTime- Payment creation date an time.
• Int Crtd_User_UsersID- Identifier of the user who has performed the payment.
• Int DocDate- Document issuing date.
• Str Description- Description of the document.
• Str BranchID- Identifier of the sales branch associated with the account. The value of this field is null because this parameter is not applicable to the payment and refund document types.
• Str SalesID- Identifier of the sales person associated with the account. The value of this field is null because this parameter is not applicable to the payment and refund document types.
• Int PayToolID- Identifier of the payment method used to process the payment.
• Int ETransStatus- Status of the payment processing. The status can be one of the following:
  • 0 – New
  • 1 – Approved by Vendor
  • 2 – Approved by Gate
  • 3 – Declined by Gate
  • 4 – Declined by Vendor
  • 5 – Fraud
  • 6 – Auth Call
  • 7 – Money Captured
  • 8 – Void
  • 9 – Refunded
  • 10 – Authorizing
  • 11 – Capturing
  • 12 – Selling
  • 13 – Voiding Auth
  • 14 – Voiding Capture
  • 15 – Voiding Sell
  • 16 – Voiding Refund
  • 17 – Refunding
  • 18 – Voiding Redirect
  • 19 – Redirecting
  • 100 – Canceled
• Str FromIP– IP address of the customer from which the payment is performed.
• Str AuthCode– Authorization code.
• Str TrNumber– Payment reference number.
• Int PTransActivityID– Identifier of the previous transaction used for refund.
• Int Benef_AccountID– Account that actually receives the money charged (applicable, for example, in case of reselling).
• Int PluginID– Identifier of the plug-in (processing center) used to process the payment.
• Int ChrgAttempts– Number of attempts to charge for the purchase.
• Int PayToolType– Type of the payment method used to process the payment. The type can be one of the following:
  • 0 – Credit Card
  • 1 – Bank Account
  • 2 – External Redirect
  • 3 – Check/Cash
  • 5 – Direct Debit
  • 6 – Universal