Original Credit Transaction - dboctdisbursement

Original Credit Transaction (OCT) method credits funds to a recipient’s Debit Card account. OCT is an innovative payment system for fast and convenient fund transfers to over eligible cards. OCT tends to be cheaper, faster, more convenient and more traceable than traditional payment methods.

Requirements

OCT is available on terminals with the following settings:

  • Region is set to USA / Canada
  • Market Segment set to one of the following
    • Internet
    • MOTO
    • Retail
    • Service
  • Debit payments enabled

OCT is only available for Visa and MasterCard Debit cards.

Request

ssl_merchant_id
15 | numeric | required
Merchant ID
Elavon-assigned Converge account ID.
ssl_user_id
15 | alphanumeric | required
Converge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
ssl_pin
64 | alphanumeric | required
Terminal ID
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
Important: The ssl_user_id sending the transaction request must be associated with the terminal that will process the request.
ssl_transaction_type
20 | alphanumeric | required
Transaction Type
Value: dboctdisbursement
ssl_card_number
18 or 19 | numeric | required
Card Number
Unique card identification number.
Card length:
  • 18 - Gift Card
  • 19 - Credit Card
ssl_exp_date
4 | numeric | required
Card's Expiry Date
Date when the card becomes invalid. For credit card transactions that use tokens, do not send the expiry date when the token is stored in Card Manager.
Format: MMYY
ssl_oct_ref_number
16 | numeric | required
OCT Reference Number

Response

ssl_result
 
Transaction Outcome
An ssl_result = 0 indicates an approved transaction.
An ssl_result not equal to 0 indicates a declined and unauthorized transaction.
ssl_result_message
 
Transaction Result Message
Refer to the Debit Card Response Codes section for an extensive list of possible returned messages.
ssl_txn_id
 
Transaction ID
Unique identifier of the transaction.
ssl_approval_code
 
Transaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction.
ssl_txn_time
 
Processing Date and Time
Indicates when Converge processed the transaction.
Format: MM/DD/YYYY hh:mm:ss AM/PM
Example: 03/18/2010 10:34:10 AM
ssl_oct_reference_number
 
OCT Transaction Reference Number
 
ssl_reference_number
 
Transaction Reference Number
 
ssl_account_balance
 
Account Balance
Available balance on the card.
ssl_base_amount
 
Base Amount
Original transaction amount sent in the request. Returned based on the terminal setup.
ssl_card_short_description
 
Short Card Brand Name
Valid values are AMEX, CUP, DISC, MC, PP, and VISA.

Examples

Request

<txn>
    <ssl_merchant_id>0020083</ssl_merchant_id>
    <ssl_user_id>apiuser</ssl_user_id>
    <ssl_pin>GOO89LP9KW5WMYEIBWIFIVFJX2MPLCTCSFKDZ7BW4DXQ8W1RR7VYR6TDQBXVXIMD</ssl_pin>
    <ssl_transaction_type>dboctdisbursement</ssl_transaction_type>
    <ssl_card_number>4761080007841110</ssl_card_number>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_oct_ref_number>1234567890123456</ssl_oct_ref_number>
</txn>

Response

<txn>
    <ssl_transaction_type>OCTDISBURSEMENT</ssl_transaction_type>
    <ssl_card_number>47**********1110</ssl_card_number>
    <ssl_result>0</ssl_result>
    <ssl_txn_id>120620MC8-E395E10A-5546-4A24-BB1A-78FC826BE8A7</ssl_txn_id>
    <ssl_approval_code> </ssl_approval_code>
    <ssl_amount>10.00</ssl_amount>
    <ssl_txn_time>06/12/2020 04:48:52 PM</ssl_txn_time>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_oct_ref_number>1234567890123456</ssl_oct_ref_number>
    <ssl_reference_number/>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_base_amount>10.00</ssl_base_amount>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_card_type>DEBITCARD</ssl_card_type>
</txn>