developer:soap:methods:runquickcredit

Soap API v1.2

runQuickCredit

Run a credit based on the credit card details of a previous transaction.

Description

This method allows you to run a new transaction using stored customer data. Simply pass the reference number (RefNum) of a previous transaction and the gateway will automatically transfer the credit card information for use in the new transaction. Some credit card information, such as the card code and magnetic strip cannot be stored. This may cause the new transaction to come in at a higher rate than the original.

See also runTransaction, runSale, voidTransaction, runCredit, runAuthOnly

Syntax

TransactionResponse runQuickCredit ( ueSecurityToken Token, integer RefNum, TransactionDetail Details )

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
integer RefNum Unique transaction reference number assigned by the gateway.
TransactionDetail Details Request transaction details, including transaction amount, invoice number, customer ID, PO number, and other transaction specific data.

Return Value

TransactionResponse Returns a TransactionResponse object containing the results of the transaction and all relevant data.

Examples

PHP

For directions on how to set up the WSDL link, create “$token” and “$client”, go to SOAP PHP How-to.

<?php
 
try {
 
  $refnum=1009411;
  $details=array(
    "Amount"=>4.00, 
    "Invoice"=>1234,
    "Description"=>"Test Transaction",
    "PONum"=>"",
    "OrderID"=>1234,
    "Tax"=>0,
    "Tip"=>0,
    "NonTax"=>false,
    "Shipping"=>0,
    "Discount"=>0,
    "Subtotal"=>4.00
    );
 
  print_r($client->runQuickCredit($token,$refnum, $details));
 
} 
 
catch(SoapFault $e) {    
  echo $e->getMessage();
  echo "\n\nRequest: " . $client->__getLastRequest();
  echo "\n\nResponse: " . $client->__getLastResponse();
 
}
 
?> 

Java

This example uses the USAePay Java library. For directions on how to install the library and create the token/client objects, go to either the Java JAX-RPC Howto or the Java JAX-WS Howto.

try {
 
  //Set RefNum to the transaction refference number
  //you want to run a quick credit on
  BigInteger RefNum = new BigInteger("123456789");
 
  //populate transaction details
  TransactionDetail details = new TransactionDetail();
    details.setAmount(22.34);
    details.setDescription("QuickCredit");
    details.setInvoice("119891");
 
  // Create response object
  TransactionResponse response;
 
  response = client.runQuickCredit(token, RefNum, details, false);
 
  System.out.println("Response: " + response.getResult());
  System.out.println("RefNum: " + response.getRefNum());
} catch (Exception e) {
    System.out.println("Soap Exception: " + e.getMessage());
}

VB

    Dim client As usaepay.usaepayService = New usaepay.usaepayService
    Dim token As usaepay.ueSecurityToken
 
    token = Me.CreateToken("982lz9VsLm87MA54Sv8E582h8OZMArL6", "443311")
 
    Dim refnum As Integer
    Dim details As usaepay.TransactionDetail = New usaepay.TransactionDetail
 
    refnum = "46352757"
    details.Amount = "34.50"
    details.AmountSpecified = True
    details.Description = "Example QuickCredit"
    details.Invoice = "123456"
 
    Dim response As usaepay.TransactionResponse
 
    response = client.runQuickCredit(token, refnum, details, authonly)
 
    If response.ResultCode = "A" Then
      MsgBox("Transaction Approved, Reference Number: " & response.RefNum)
    ElseIf response.ResultCode = "D" Then
      MsgBox("Transaction Declined, Reason: " & response.Error)
    Else
      MsgBox("Transaction Error, Reason: " & response.Error)
    End If

XML

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ns1="urn:usaepay" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:runQuickCredit>
<Token xsi:type="ns1:ueSecurityToken">
<ClientIP xsi:type="xsd:string">192.168.0.1</ClientIP>
<PinHash xsi:type="ns1:ueHash">
<HashValue xsi:type="xsd:string">fb8305331a09c4f1002971c5974987ddb0dbba0f</HashValue>
<Seed xsi:type="xsd:string">1193442685704132440</Seed>
<Type xsi:type="xsd:string">sha1</Type>
</PinHash>
<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
</Token>
<RefNum xsi:type="xsd:integer">1118268</RefNum>
<Details xsi:type="ns1:TransactionDetail">
<Amount xsi:type="xsd:double">29</Amount>
<Clerk xsi:type="xsd:string">John Doe</Clerk>
<Currency xsi:type="xsd:integer">0</Currency>
<Description xsi:type="xsd:string">Example Transaction</Description>
<Discount xsi:type="xsd:double">1</Discount>
<Invoice xsi:type="xsd:string">44539</Invoice>
<OrderID xsi:type="xsd:string">12345</OrderID>
<PONum xsi:type="xsd:string">54321</PONum>
<Shipping xsi:type="xsd:double">2</Shipping>
<Subtotal xsi:type="xsd:double">16</Subtotal>
<Table xsi:type="xsd:string">1</Table>
<Tax xsi:type="xsd:double">4</Tax>
<Terminal xsi:type="xsd:string">15</Terminal>
<Tip xsi:type="xsd:double">8</Tip>
</Details>
</ns1:runQuickCredit>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Change History

Version Change
1.0 Method added in soap v1.0
developer/soap/methods/runquickcredit.txt · Last modified: 2009/09/10 12:55 by charlie

Page Tools