Batch (sFTP) APIs

Examples



Processing Request Header Record

accountId|accountType|accountAccessory|transactionCode|transactionDate|transactionType|amount|holderName|holderType|accountNumber|taxAmount|street|city|state|zipCode|phone|email|itemCode|customerAccountCode|memo
The request file must contain a header record with field names corresponding to the values provided. Field order is not important (except using of legacy systems).

Note: not all available fields are included.

Processing Response Header Record

accountId|accountNumberMasked|accountAccessory|accountType|transactionType|providerTransactionCode|transactionCode|transactionInternalCode|transactionDate|submissionId|transactionId|originalTransactionId|originalTransactionCode|originalTransactionDate|isRebillEnabled|amount|holderName|responseCode|responseMessage
The response file must contain a header record with field names corresponding to the values provided. Field order is not important (except using of legacy systems).

Note: not all available fields are included.

Error Header Record

errorCode|errorMessage
If an error file is generated by the system, the extension of the file will be .error.
Validation Header Record

accountId|amount|transactionCode|taxAmount|transactionDate|holderType|amount|holderName|taxAmount|street|accountType|city|accountAccessory|state|accountNumber|zipCode|holderName|phone|holderType|email|street|itemCode|city|memo|state|transactionCode|zipCode|transactionDate|phone|merchantAccountCode|email|accountType|itemCode|accountNumber|customerAccountCode|accountAccessory|memo|customerAccountCode|errorCode|errorMessage
If a validation file is generated by the system, the extension of the file will be .validation.
Returns Header Record

accountId|transactionCode|transactionDate|transactionId|responseCode|responseMessage|avsResponseCode|token|accountNumberUpdated|accountAccessoryUpdated|tokenUpdated|transactionType|submissionId|originalTransactionId|isRebillEnabled|sequenceNumber|transactionInternalCode|accountTypeUpdated|holderNameUpdated|retryFeeAmount|expectedEffectiveDate|warningCode|amount|accountNumberMasked|accountAccessory|accountType|holderName|aggregateTransactionId|aggregateTransactionCode|aggregateTransactionInternalCode|approvalCode|processedAmount|providerResponseCode|providerResponseMessage|providerAvsResponseCode|originalTransactionCode|originalTransactionDate|providerTransactionCode
Tokenization Request Header Record

accountId|transactionCode|accountNumber|accountType
Tokenization Response Header Record

accountId|transactionCode|accountType|token|responseCode|responseMessage
Note that transactionDate of the response message is the date when CC transaction was captured/declined or when an ACH return arrived. ACH returns come in within 60 days of the processing date. Therefore, response files may contain ACH returns from the prior submission dates. It is recommended to use transactionCode value to correctly identify the original transaction submitted in the past.

For ACH responses will be generated; all valid and non-blacklisted transactions will come back as approved.

Account Update Request Header Record

accountId|transactionCode|accountType|accountNumber|accountAccessory|customerAccountCode
To process transactions with Account Update, the .au must be added into the file name before the file extention.
Account Update Response Header Record

accountId|responseCode|responseMessage|transactionCode|accountNumberUpdated|accountAccessoryUpdated|transactionId
Legacy Systems

accountId|transactionCode|transactionDate|transactionId|responseCode|responseMessage|avsResponseCode|token|accountNumberUpdated|accountAccessoryUpdated|tokenUpdated|transactionType|submissionId|originalTransactionId|isRebillEnabled|sequenceNumber|transactionInternalCode|accountTypeUpdated|holderNameUpdated|retryFeeAmount|expectedEffectiveDate|warningCode|amount|accountNumberMasked|accountAccessory|accountType|holderName|aggregateTransactionId|aggregateTransactionCode|aggregateTransactionInternalCode|approvalCode|processedAmount|providerResponseCode|providerResponseMessage|providerAvsResponseCode|originalTransactionCode|originalTransactionDate
Generally we recommend integrators not to rely on the column order and use file headers included in every file. However, for legacy systems, where the only option is rely on column order, the order of columns from the example of a response header record above can be used.

Please note, that the length of values is not fixed; however, it will not exceed the maximum length indicated in the specification for respective field. All columns will always be present in the file. An empty column is represented by a 'pipe' separator with no spaces or values. It will visually appear as two consecutive pipes, for example:
sale|John Smith||2000
1st column: sale 2nd column: John Smith
3rd column: empty
4th column: 2000
Please be advised that additional columns may be added. You will be notified in advance of such changes if you are subscribed to the specification updates.
Subscriptions File Request Header Record

accountId|accountType|accountNumber|accountAccessory|transactionCode|customerAccountCode|holderName|holderType|email|phone|street|city|countryCode|state|zipCode
Subscriptions File Response Header Record

accountId|accountNumberMasked|accountAccessoryMasked|accountType|transactionCode|customerAccountCode|responseCode|responseMessage|subscriptionCode
Returns Account Update Header Record

accountId|responseCode|responseMessage|transactionCode|accountNumberMasked|token|accountNumberUpdated|accountAccessoryUpdated|tokenUpdated|customerAccountCode|customerAccountInternalCode|transactionInternalCode|transactionId
Charges Request Header Record

accountId|chargeCode|chargeType|amount|description|expectedEffectiveDate
Charges Response Header Record

accountId|chargeId|chargeCode|chargeType|amount|description|expectedEffectiveDate|responseCode|responseMessage
Charges Payments Response Header Record

accountId|chargeId|chargeCode|paymentAmount|remainingAmount|sequenceNumber
Capture Request Header Record

accountId|transactionId|amount
Capture Response Header Record

accountId|transactionId|@transactionId|amount|uncapturedAmount|cycleCode|responseCode|responseMessage
Returns Subscription Header Record

accountId|accountType|accountNumberMasked|accountAccessoryMasked|token|transactionCode|transactionId|customerAccountCode|responseCode|responseMessage|providerResponseCode|providerResponseMessage|providerTransactionCode