OfflineCard Cassette financial commands
For each WebSphere Commerce Payments API command, the following sections describe:
- How, or whether, each optional framework parameter is supported by the OfflineCard Cassette
- Any special notes related to the OfflineCard Cassette handling of framework parameters
- All OfflineCard Cassette-specific protocol parameters
For required framework parameters, refer to the framework objects tables.
AcceptPayment
| Keyword | Required / Optional | Value |
|---|---|---|
| APPROVEFLAG | O | Fully supported. ASCII integer 0, 1, or 2. |
| PAYMENTAMOUNT | O/R | Fully supported. Required if APPROVEFLAG is set to 1 or 2. Positive integer in ASCII characters from 1 to 4,228,250,625. |
| DEPOSITFLAG | O | Fully supported. ASCII Integer 0 or 1. |
| $PAN | R | Payment card number (Personal Account Number) ASCII from 12 to 19 bytes. |
| $BRAND | R | Payment card brand. ASCII from 1 to 40 bytes. |
| $EXPIRY | R | Payment card expiration date. ASCII 6 bytes in yyyymm format. |
| $AVS.COUNTRYCODE | O | Country code of cardholder's billing address. This field allows national language characters including DBCS. 3 to 50 bytes. |
| $AVS.CITY | O | City of cardholder's billing address. This field allows national language characters including DBCS. 1 to 50 bytes. |
| $AVS.STREETADDRESS | O | Street address of cardholder's billing address. This field allows national language characters including DBCS. 1 to 128 bytes. |
| $AVS.STATEPROVINCE | O | State/province of cardholder's billing address. This field allows national language characters including DBCS, 1 to 50 bytes. |
| $AVS.POSTALCODE | O | Postal (zip) code of cardholder's billing address. This field allows national language characters including DBCS, 1 to 14 bytes. |
| $CARDHOLDERNAME | O | Cardholder name. This field allows national language characters including DBCS. 1 to 64 bytes. |
| $AUTHCODE | O | Authorization code to be saved with the approved Payment. This parameter is only required if APPROVEFLAG=1 or 2. It is also specified on the AcceptPayment command. Must be an ASCII character string from 1 to 64 bytes long. If $AUTHCODE is specified, then a Payment is created in PAYMENT_APPROVED state for the Order amount and the ReferenceNumber is set to the $AUTHCODE value. If specified with $DECLINEREASON, the command will fail with PRC_INVALID_PARAMETER_COMBINATION, RC_CASSETTE_AUTHCODE_ AND_DECLINEREASON. If neither this parameter nor $DECLINEREASON is specified with APPROVEFLAG=1 or 2, an approved payment is created for the order amount with an empty ReferenceNumber. |
| $DECLINEREASON | O | Decline code to be saved with the declined Payment. This parameter is only used if APPROVEFLAG=1 or 2. It is also specified on the AcceptPayment command. Must be an ASCII character string from 1 to 254 bytes long. If $DECLINEREASON is specified, then a Payment is also created in PAYMENT_DECLINED state and the ReferenceNumber is set to the $DECLINEREASON value. If specified with $AUTHCODE, the command will fail with PRC_INVALID_PARAMETER_COMBINATION, RC_CASSETTE_AUTHCODE_ AND_DECLINEREASON. |
| $AVSCODE | O | AVS code to be saved with the Payment. This parameter is only used if APPROVEFLAG=1 or 2. It is also specified on the AcceptPayment command. Must be an ASCII character string from 1 to 3 bytes long. |
Approve
| Keyword | Required / Optional | Value |
|---|---|---|
| DEPOSITFLAG | O | Fully supported. |
| $AUTHCODE | O | Authorization code to be saved with the approved Payment. Must be an ASCII character string from 1 to 16 characters long. If $AUTHCODE is specified, the Payment is created in PAYMENT_APPROVED state and the ReferenceNumber is set to the $AUTHCODE value. If neither this parameter nor $DECLINEREASON is specified, the Payment will be created in PAYMENT_APPROVED state with an empty ReferenceNumber. If specified with $DECLINEREASON, the command will fail with PRC_INVALID_PARAMETER_COMBINATION, RC_CASSETTE_AUTHCODE_AND_DECLINEREASON. |
| $DECLINEREASON | O | Decline code to be saved with the declined Payment. Must be an ASCII character string from 1 to 254 characters long. If $DECLINEREASON is specified, then the Payment is created in PAYMENT_DECLINED state and the declineReason field is set to the $DECLINEREASON value. If not specified with $AUTHCODE, the command will fail with PRC_INVALID_PARAMETER_COMBINATION, RC_CASSETTE_AUTHCODE_AND_DECLINEREASON. |
| $AVSCODE | O | AVS code to be saved with the Payment. Must be an ASCII character string from 1 to 3 characters long. |
BatchClose
| Keyword | Required / Optional | Value |
|---|---|---|
| $FIBATCHID | O | Specifies the financial institution's identifier for the batch. This parameters allows the Merchant to correlate the local batch object to an entity at the financial institution. If specified, the value is saved as the fiBatchId value in the OfflineCard cassette's extension to the Batch object. Otherwise, that field is left empty. Must be an ASCII character string from 1 to 32 characters long. |
Refund
| Keyword | Required / Optional | Value |
|---|---|---|
| $AUTHCODE | O | Authorization code to be saved with the approved Credit. Must be an ASCII character string from 1 to 64 characters long. If $AUTHCODE is specified, the Credit is created in CREDIT_APPROVED state and the ReferenceNumber is set to the $AUTHCODE value. If neither this parameter nor $DECLINEREASON is specified, the Credit is created in CREDIT_APPROVED state with an empty ReferenceNumber. If specified with $DECLINEREASON, the command will fail with PRC_INVALID_PARAMETER_COMBINATION, RC_CASSETTE_AUTHCODE_AND_DECLINEREASON. |
| $DECLINEREASON | O | Decline code to be saved with the declined Credit. Must be an ASCII character string from 1 to 254 characters long. If $DECLINEREASON is specified, the Credit is created in CREDIT_DECLINED state and the declineReason field is set to the $DECLINEREASON value. If specified with $AUTHCODE, the command will fail with PRC_INVALID_PARAMETER_COMBINATION, RC_CASSETTE_AUTHCODE_AND_DECLINEREASON. |
Other supported financial commands
The following financial commands are supported without any optional or protocol data parameters:
- ApproveReversal modifies the approved amount of a payment.
- BatchPurge clears out a batch and returns the batch object to the open state.
- CancelOrder moves an order into the canceled state.
- CloseOrder moves an order into the closed state.
- DepositReversal disassociates a payment from a batch.
- DeleteBatch removes the specified batch from the database tables.
- RefundReversal voids existing credit objects.
Unsupported financial commands
The following financial commands are not supported and
always return the primary and secondary return codes of PRC_COMMAND_NOT_SUPPORTED,
RC_NONE:
- BatchOpen
- ReceivePayment