Invoice Number

The merchant can include an invoice number in a transaction to track related transactions.

error_outline
note

This feature is only available if enabled in Converge. Refer to Get Converge Account Information for more information.

Code Samples

CWS

Request

parameters
JSONObject | required
All relevant parameters for tokenization.
 
invoiceNumber
string | optional
Invoice Number
 

Example (Request)

{
  "method" : "startPaymentTransaction",
  "requestId" : "1578283620",
  "targetType" : "paymentGatewayConverge",
  "version" : "1.0",
  "parameters" : {
    "paymentGatewayId" : "d5b9ea11-a9a7-4888-8458-2f609656579f",
    "transactionType" : "SALE",
    "tenderType" : "CARD",
  .....
    "invoiceNumber" : "T01",
  .....
  }
}

Java

private void setInvoiceNumber(ECLTransactionInterface transaction,
        GetCardTransactionPropertiesDialog getCardTransactionPropertiesDialog)
{
    String invoiceNumber = getCardTransactionPropertiesDialog.getInvoiceNumber();
    if (null != invoiceNumber)
    {
        transaction.setInvoiceNumber(invoiceNumber);
    }
}

Objective-C

Request

id<ECLTransactionProtocol> resultingTransaction;

//initilize resultingTransaction with a specific protocol such as ECLCurrencyTransactionProtocol or ECLStandaloneRefundTransactionProtocol
...

if ([_invoiceNumber.text length] > 0) 
{
    [_resultingTransaction setInvoiceNumber:_invoiceNumber.text];
}

C#

Request

PaymentArgs paymentArgs = new PaymentArgs();

...

paymentArgs.invoiceNumber = tb_InvoiceNum.Text;