Payments API

The AuricVault® Payments Passthrough API uses a JSON-RPC structure similar to the Token interface. Refer to the Custom HTTP Headers section for generating X-VAULT-HMAC and X-VAULT-TRACE-UID headers.

The X-VAULT-TRACE-UID header value submitted with the request is returned in the traceUid response code.

Request Fields

The following tables describe the standard AuricVault® request field names for the payments API. Not all processors support all fields. Please refer to the specific section for your payment processor.

Processor Credentials

Field

Description

processorId

Which payment processor to use. See processorId.

processorUserId

UserId or username.

processorPassword

Processor password.

processorAccessKey

Processor access key.

processorDivision

Division when multiple divisions supported.

Note

The service passes through your payment processor account credentials.

Common Fields

Field

Description

action

See action.

affiliate

Merchant affiliate.

amount

Decimal amount for transaction.

authorizationCode

For settlement

auvToken

AuricVault® token.

cardOnFileTransactionId

See Card-on-File section.

commerceIndicator

See commerceIndicator

currency

Three-character currency code. See ISO Currency Codes.

cvv2

Card security code.

expirationDate

YYYY-MM.

merchantInitiated

Merchant initiated subsequent transaction: ‘true’ or ‘false’.

mop

See mop.

processorToken

Processor-specific Token.

processorTransactionId

Usually returned by an Auth or Sale transaction.

requestPartialAuthorization

Allow partial auth or sale authorization.

requestProcessorTransaction

Return processor transaction: ‘true’ or ‘false’.

Bill To

Field

billToAddress_1

billToAddress_2

billToAddress_3

billToCity

billToCompany

billToCountry

billToEmail

billtoFax

billToFirstName

billToMiddleInitial

billToLastName

billToPhoneNumber

billToPostalCode

billToStateProvince

Ship To

Field

Description

shippingMethod

See shippingMethod table.

shipToAddress_1

shipToAddress_2

shipToAddress_3

shipToCity

shipToCountry

shiptoFax

shipToFirstName

shipToLastName

shipToPhoneNumber

shipToPostalCode

shipToStateProvince

Enhanced Data

Field

Description

enhDailyRate

enhIndustryCode

enhIsNoShow

enhNameOfPlace

enhRequestorName

enhStatementEndDate

enhStatementStartDate

3D Secure

Field

Description

mcssAuthData

ucafCollectionIndicator

vbvCavv

vbvId

Additional

Field

Description

cscPresenceIndicator

See cscPresenceIndicator

campaign

TODO Vantiv description

customerBrowserType

customerHostname

customerId

Merchant identifier for customer.

customerIp

Example: 192.168.3.254

merchantTaxId

Digits only, with no spaces or dashes.

processorCustomerId

Identify a customer at the gateway.

processorReportGroup

Declare reporting group for this transaction.

reversalReason

TODO Vantiv reversal Reason

Dynamic Merchant Data

Field

Description

merchantCategoryCode

merchantCity

merchantEmail

merchantName

merchantPhone

merchantPostalCode

merchantProfileId

merchantState

merchantUrl

Standard Field Values

processorId

Value

Description

braintree

Braintree Payments

cps-orbital

Chase Paymentech Solutions Orbital Gateway/Salem

mes-trident

Merchant e-Solutions/Trident Gateway

tsys-transit

Tsys/Transit Multipass Gateway

vantivLitle

Worldpay (formerly Vantiv, formerly Litle & Co.)

action

Value

Description

sale

authorize and settle

auth

authorize only (pre-auth)

capture

capture all funds for settlement

multi-capture

capture some of the funds for settlement

refund

with transaction ID

credit

return funds using auvToken or processor token

create token

generate processor-specific token

verify

verify card account info without authorizing

offline

capture voice authorized transaction Contact Auric support if you need this functionality.

void auth

void authorization using transaction ID

void capture

void capture using transaction ID

void refund

void refund using transaction ID

void sale

void sale using transaction ID

void credit

void credit using transaction ID

Note

Some notes on capture vs. multi-capture. Refer to the specific processor’s documentation for details.

  • Always pass the amount parameter for capture and multi-capture.

  • Use capture to capture the full amount authorized. Some processors only allow the full amount to be captured.

  • Use multi-capture to capture less than the full amount.

  • Some processors allow multi-capture to capture a single authentication in more than one piece.

mop

Method of Payment.

Value

Description

AX

American Express

DI

Discover

JC

JCB

MC

MasterCard

VI

Visa

commerceIndicator

Value

Description

ecommerce

E-commerce transaction

installment

Installment. (‘n’ payments)

mailorder

Mail order

recurring

Recurring (ongoing vs. ‘n’ payments)

retail

Manually keyed

telephone

Telephone order

IVR

Interactive Voice Response

initialCardOnFile

Tokenized card will be used for future unscheduled transactions.

initialInstallment

Tokenized card will be used for installment transactions.

initialMailOrder

Tokenized card will be used for future unscheduled transactions.

initialRecurring

Tokenized card will be used for recurring transactions.

initialTelephone

Tokenized card will be used for future unscheduled transactions.

initialIVR

Tokenized card will be used for future unscheduled transactions.

cardOnFileEcommerce

Using stored card.

cardOnFileMailOrder

Using stored card.

cardOnFileTelephone

Using stored card.

3dsAttempted

Attempted 3DSecure, but not completed.

3dsAuthenticated

3DSecure authentication successful.

initial3dsAttempted

Attempted 3DSecure, but not completed.

initial3dsAuthenticated

3DSecure authentication successful.

cscPresenceIndicator

Ecommerce transactions do not need to provide this field. It is automatically set to “1” if the cvv2Code is provided, otherwise defaults to “0”.

Value

Description

0

You are not submitting a Card Security Code. (Default)

1

Code is included in the Auth/Sale transaction.

2

Card holder has stated the code is illegible.

9

Card holder has stated the code is not on the card.

shippingMethod

Value

same_day

overnight

priority

ground

electronic

Response Fields

Field

Description

responseCode

Generalized Response Code

responseText

Generalized Response Text

authorizationCode

Auth code from the Payment Processor

authorizationDateTime

Authorization date/time

avsResponse

Generalized Address Verification response

cardOnFileTransactionId

See Card-on-File section.

cvv2Response

Generalized card security code response

cardType

Card type (if requested)

partialAuthAmount

Amount actually authorized.

processorToken

Processor-specific token.

processorTransactionId

Processor transaction ID.

processorAvsResponse

AVS Response from Processor

processorCvv2Response

Card security code response from Processor.

processorResponseCode

Processor response code.

processorResponseText

Processor response text.

elapsedProcessorTime

Elapsed time spent at payment processor.

toProcessor

Processor-formatted request (sanitized).

fromProcessor

Processor-formatted response (sanitized).