Auth Only is a request to check whether a credit card is valid and has the funds to complete a specific transaction (i.e. purchase). It does not actually run the charge on the card, but does temporarily hold the funds aside. Note that each credit card company will only hold the authorization for a limited period (for example, 3-10 days, depending on the credit card scheme).
Zero value auth for card validity checks
If you wish to check the validity of a card without authorizing any charge amount, simply enter 0 as the value for the
amount
property in this request.
Tip
You can test out a request that hits our sandbox in real-time. Follow the instructions here to use the "Try It!" feature on the right side.
Request Content
Send a cardTransaction object, with the following:
Property | Type | Required |
---|---|---|
walletId | long | required if using Visa Checkout |
wallet | object | required if using Apple Pay or Google Pay™ (refer to wallet) |
amount | decimal | required |
vaultedShopperId | integer | required if using a vaulted shopper |
updateShopperWithCardholderInfo | string | optional |
merchantTransactionId | string | optional |
softDescriptor | string | optional |
descriptorPhoneNumber | string | optional |
vendorsInfo | container | optional Applicable if using marketplace vendor(s) (refer to vendorsInfo) |
cardHolderInfo | object | required for LatAm local processing (refer to cardHolderInfo) |
currency | string | required |
transactionFraudInfo | object | optional (refer to transactionFraudInfo) |
creditCard | object | required if sending card data or if vaulted shopper has multiple cards. Do not include if sending pfToken or wallet (refer to creditCard) |
cardTransactionType | string | required, value must be AUTH_ONLY |
threeDSecure | object | optional (refer to threeDSecure) |
transactionMetaData | object | optional (refer to transactionMetaData) |
pfToken | string | required if using Hosted Payment Fields or Secured Payment Collector |
level3Data | object | optional (refer to level3Data) |
storeCard | boolean | optional (refer to cardTransaction) |
Note
Non-reusable cards cannot be used as a payment method.
Response Details
If successful, the response HTTP status code is 200 OK.
The response contains the request properties plus these additions:
Property | Included in response if |
---|---|
vaultedShopperId | |
processingInfo | |
fraudResultInfo | fraud prevention is enabled |
threeDSecure | sending 3D Secure authentication data |
transactionId | |
vendorsInfo | using marketplace vendor(s) |
level3Data | if sending Level 2/3 data |
storeCard | sending store card data |
Examples
Request Examples
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 11,
"softDescriptor": "DescTest",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453"
},
"currency": "USD",
"transactionFraudInfo": {
"shopperIpAddress": "123.12.134.1",
"fraudSessionId": 1234,
"customerId": "121341",
"customerCreationDate": "2021-08-05",
"company": "BBBBB",
"shippingContactInfo": {
"zip": "02453",
"country": "US",
"firstName": "YY",
"lastName": "LL",
"city": "Juneau",
"address2": "Address2",
"address1": "Address1",
"state": "AL"
}
},
"creditCard": {
"expirationYear": "2023",
"securityCode": "837",
"expirationMonth": "02",
"cardNumber": "4263982640269299"
},
"cardTransactionType": "AUTH_ONLY"
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 11,
"softDescriptor": "DescTest",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453"
},
"currency": "USD",
"transactionFraudInfo": {
"enterpriseSiteId": "DEFAULT",
"shopperIpAddress": "123.12.134.1",
"fraudSessionId": 1234,
"customerId": "121341",
"customerCreationDate": "2021-08-05",
"enterpriseUdfs": {"udf": [
{
"udfValue": "aaa",
"udfName": "ENT_UDF1"
},
{
"udfValue": "bbb",
"udfName": "ENT_UDF2"
}
]},
"company": "BBBBB",
"shippingContactInfo": {
"zip": "02453",
"country": "US",
"firstName": "YY",
"lastName": "LL",
"city": "Juneau",
"address2": "Address2",
"address1": "Address1",
"state": "AL"
}
},
"creditCard": {
"expirationYear": "2023",
"securityCode": "837",
"expirationMonth": "02",
"cardNumber": "4263982640269299"
},
"cardTransactionType": "AUTH_ONLY"
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 11,
"vaultedShopperId": 20781033,
"softDescriptor": "DescTest",
"currency": "USD",
"cardTransactionType": "AUTH_ONLY"
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 11,
"vaultedShopperId": 20769005,
"softDescriptor": "DescTest",
"currency": "USD",
"creditCard": {
"cardLastFourDigits": "9299",
"cardType": "VISA"
},
"cardTransactionType": "AUTH_ONLY"
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 11,
"softDescriptor": "DescTest",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453"
},
"currency": "USD",
"creditCard": {
"expirationYear": "2023",
"securityCode": "837",
"expirationMonth": "02",
"cardNumber": "4263982640269299"
},
"cardTransactionType": "AUTH_ONLY",
"transactionMetaData": {"metaData": [
{
"metaValue": 20,
"metaKey": "stateTaxAmount",
"metaDescription": "State Tax Amount"
},
{
"metaValue": 20,
"metaKey": "cityTaxAmount",
"metaDescription": "City Tax Amount"
},
{
"metaValue": 10,
"metaKey": "shippingAmount",
"metaDescription": "Shipping Amount"
}
]}
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 11,
"currency": "USD",
"merchantTransactionId": "cc-412",
"cardHolderInfo": {
"firstName": "Jane",
"lastName": "Smith",
"zip": "02453"
},
"creditCard": {
"expirationYear": "2023",
"securityCode": "837",
"expirationMonth": "02",
"cardNumber": 4263982640269299
},
"cardTransactionType": "AUTH_ONLY"
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"walletId": 21,
"amount": 11,
"currency": "USD",
"cardTransactionType": "AUTH_ONLY"
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 11,
"softDescriptor": "DescTest",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453"
},
"currency": "USD",
"cardTransactionType": "AUTH_ONLY",
"pfToken": "abcde12345**********"
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 11,
"softDescriptor": "DescTest",
"vendorsInfo": {
"vendorInfo": [
{"vendorId": "514147"}
]
},
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453"
},
"currency": "USD",
"transactionFraudInfo": {
"shopperIpAddress": "123.12.134.1",
"fraudSessionId": 1234,
"company": "BBBBB",
"shippingContactInfo": {
"zip": 02453,
"country": "US",
"firstName": "YY",
"lastName": "LL",
"city": "Juneau",
"address2": "Address2",
"address1": "Address1",
"state": "AL"
}
},
"creditCard": {
"expirationYear": "2023",
"securityCode": "837",
"expirationMonth": "02",
"cardNumber": 4263982640269299
},
"cardTransactionType": "AUTH_ONLY"
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"cardTransactionType": "AUTH_ONLY",
"softDescriptor": "DescTest",
"amount": 11.00,
"currency": "USD",
"wallet": {
"walletType": "APPLE_PAY",
"encodedPaymentToken": "ImRhdGEiOiJuY1AvRitIUy8zeG5bXhCMFd"
}
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 11,
"vaultedShopperId": 20769005,
"softDescriptor": "DescTest",
"currency": "USD",
"creditCard": {
"cardLastFourDigits": "9299",
"cardType": "VISA",
"securityCode": "837"
},
"cardTransactionType": "AUTH_ONLY"
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"cardTransactionType": "AUTH_ONLY",
"softDescriptor": "DescTest",
"amount": "11.00",
"currency": "USD",
"vaultedShopperId": "20769005",
"creditCard": {
"cardNumber": "4012000033330026",
"securityCode": "111",
"expirationMonth": "07",
"expirationYear": "2023"
}
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"amount": 11,
"softDescriptor": "DescTest",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453"
},
"currency": "USD",
"transactionFraudInfo": {
"shopperIpAddress": "123.12.134.1",
"fraudSessionId": 1234,
"company": "BBBBB",
"shippingContactInfo": {
"zip": 02453,
"country": "US",
"firstName": "YY",
"lastName": "LL",
"city": "Juneau",
"address2": "Address2",
"address1": "Address1",
"state": "AL"
}
},
"creditCard": {
"expirationYear": "2023",
"securityCode": "837",
"expirationMonth": "02",
"cardNumber": "4263982640269299"
},
"cardTransactionType": "AUTH_ONLY",
"storeCard": true
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"cardTransactionType": "AUTH_ONLY",
"softDescriptor": "DescTest",
"amount": 11.00,
"currency": "USD",
"wallet": {
"walletType": "GOOGLE_PAY",
"encodedPaymentToken": "ImRhdGEiOiJuY1AvRitIUy8zeG5bXhCMFd"
}
}'
Note:
To test Apple Pay, follow the steps in the Apple Pay Guide. The API Explorer does not support Apple Pay testing.
Response Examples
{
"amount": 11,
"vaultedShopperId": 1234,
"processingInfo": {
"avsResponseCodeAddress": "M",
"processingStatus": "success",
"cvvResponseCode": "MA",
"avsResponseCodeName": "U",
"avsResponseCodeZip": "M",
"transactionRegion": "MA"
},
"softDescriptor": "BLS*DescTest",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453"
},
"currency": "USD",
"fraudResultInfo": {"deviceDataCollector": "Y"},
"creditCard": {
"cardLastFourDigits": 9299,
"cardSubType": "CREDIT",
"cardType": "VISA",
"cardCategory": "CLASSIC"
},
"cardTransactionType": "AUTH_ONLY",
"transactionId": 38488222
}
{
"amount": 11,
"vaultedShopperId": 19549066,
"processingInfo": {
"avsResponseCodeAddress": "M",
"processingStatus": "success",
"avsResponseCodeName": "U",
"avsResponseCodeZip": "M"
},
"softDescriptor": "BLS*DescTest",
"currency": "USD",
"creditCard": {
"cardLastFourDigits": 9299,
"cardSubType": "CREDIT",
"cardType": "VISA",
"cardCategory": "CLASSIC"
},
"cardTransactionType": "AUTH_ONLY",
"transactionId": 38488224
}
{
"amount": 11,
"vaultedShopperId": 1234,
"processingInfo": {
"avsResponseCodeAddress": "U",
"processingStatus": "success",
"cvvResponseCode": "MA",
"avsResponseCodeName": "U",
"avsResponseCodeZip": "U"
},
"softDescriptor": "BLS*DescTest",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453"
},
"avsResponseCode": "G",
"currency": "USD",
"creditCard": {
"cardLastFourDigits": 9299,
"cardSubType": "CREDIT",
"cardType": "VISA",
"cardCategory": "CLASSIC"
},
"cardTransactionType": "AUTH_ONLY",
"transactionMetaData": {"metaData": [
{
"metaValue": 20,
"metaKey": "stateTaxAmount",
"metaDescription": "State Tax Amount"
},
{
"metaValue": 20,
"metaKey": "cityTaxAmount",
"metaDescription": "City Tax Amount"
},
{
"metaValue": 10,
"metaKey": "shippingAmount",
"metaDescription": "Shipping Amount"
}
]},
"transactionId": 38497126
}
{
"cardTransactionType": "AUTH_ONLY",
"merchantTransactionId": "cc-412",
"transactionId": "1035748005",
"softDescriptor": "BLS*default_descriptor",
"amount": 11,
"usdAmount": 11,
"currency": "USD",
"cardHolderInfo": {
"firstName": "Jane",
"lastName": "Smith",
"zip": "02453"
},
"vaultedShopperId": 28911419,
"creditCard": {
"cardLastFourDigits": "9299",
"cardType": "VISA",
"cardSubType": "CREDIT",
"cardCategory": "PLATINUM",
"binCategory": "CONSUMER",
"cardRegulated": "N",
"issuingBank": "ALLIED IRISH BANKS PLC",
"issuingCountryCode": "ie"
},
"processingInfo": {
"processingStatus": "success",
"cvvResponseCode": "MA",
"authorizationCode": "02453",
"avsResponseCodeZip": "U",
"avsResponseCodeAddress": "U",
"avsResponseCodeName": "U"
},
"fraudResultInfo": {}
}
{
"amount": 11,
"vaultedShopperId": 123,
"processingInfo": {
"processingStatus": "success",
"cvvResponseCode": "NC"
},
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name"
},
"currency": "USD",
"creditCard": {
"cardLastFourDigits": 9299,
"cardSubType": "CREDIT",
"cardType": "VISA",
"cardCategory": "CLASSIC"
},
"cardTransactionType": "AUTH_ONLY",
"transactionId": 1011702615
}
{
"amount": 11,
"vaultedShopperId": 1234,
"processingInfo": {
"avsResponseCodeAddress": "M",
"processingStatus": "success",
"cvvResponseCode": "MA",
"avsResponseCodeName": "U",
"avsResponseCodeZip": "M"
},
"softDescriptor": "BLS*DescTest",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453"
},
"currency": "USD",
"creditCard": {
"cardLastFourDigits": 9299,
"cardSubType": "CREDIT",
"cardType": "VISA",
"cardCategory": "CLASSIC"
},
"cardTransactionType": "AUTH_ONLY",
"transactionId": 38486450
}
{
"cardTransactionType": "AUTH_ONLY",
"vendorInfo": {
"vendorId": 514147,
"commissionPercent": 20
},
"vendorsInfo": {
"vendorInfo": [
{
"vendorId": 514147,
"commissionPercent": 20
}
]
},
"transactionId": "1015593705",
"softDescriptor": "BLS*DescTest",
"amount": 11,
"currency": "USD",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453"
},
"vaultedShopperId": 22324271,
"creditCard": {
"cardLastFourDigits": "9299",
"cardType": "VISA",
"cardSubType": "CREDIT",
"cardCategory": "GOLD"
},
"processingInfo": {
"processingStatus": "success",
"cvvResponseCode": "MA",
"avsResponseCodeZip": "U",
"avsResponseCodeAddress": "U",
"avsResponseCodeName": "U"
}
}
{
"cardTransactionType": "AUTH_ONLY",
"transactionId": 38486450,
"softDescriptor": "BLS*DescTest",
"amount": 11,
"currency": "USD",
"vaultedShopperId": 1234,
"wallet": {
"walletType": "APPLE_PAY",
"billingContactInfo": {
"firstName": "John",
"lastName": "Doe",
"address1": "61 Main St.",
"city": "New York",
"state": "NY",
"zip": "02453",
"country": "us"
},
"tokenizedCard": {
"dpanExpirationMonth": "7",
"dpanExpirationYear": "2019",
"dpanLastFourDigits": "0010",
"cardLastFourDigits": "1471",
"cardType": "MASTERCARD",
"cardSubType": "DEBIT",
"binCategory": "CONSUMER",
"cardRegulated": "N",
"issuingCountryCode": "us"
}
},
"processingInfo": {
"processingStatus": "success",
"cvvResponseCode": "MA",
"avsResponseCodeZip": "M",
"avsResponseCodeAddress": "M",
"avsResponseCodeName": "U"
}
}
{
"cardTransactionType": "AUTH_ONLY",
"transactionId": "1012751945",
"softDescriptor": "BLS*DescTest",
"amount": 11,
"currency": "USD",
"vaultedShopperId": 20769005,
"creditCard": {
"cardLastFourDigits": "9299",
"cardType": "VISA",
"cardSubType": "CREDIT",
"cardCategory": "CLASSIC"
},
"processingInfo": {
"processingStatus": "success",
"avsResponseCodeZip": "U",
"avsResponseCodeAddress": "U",
"avsResponseCodeName": "U"
}
}
{
"cardTransactionType": "AUTH_ONLY",
"transactionId": "1014303431",
"softDescriptor": "BLS*DescTest",
"amount": 11,
"currency": "USD",
"vaultedShopperId": 20769005,
"creditCard": {
"cardLastFourDigits": "0026",
"cardType": "VISA",
"cardSubType": "CREDIT",
"cardCategory": "CLASSIC"
},
"processingInfo": {
"processingStatus": "success",
"cvvResponseCode": "ND",
"avsResponseCodeZip": "U",
"avsResponseCodeAddress": "U",
"avsResponseCodeName": "U"
}
}
{
"cardTransactionType": "AUTH_ONLY",
"transactionId": "1016888481",
"softDescriptor": "BLS*DescTest",
"amount": 11,
"currency": "USD",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "123456"
},
"vaultedShopperId": 22730353,
"creditCard": {
"cardLastFourDigits": "9299",
"cardType": "VISA",
"cardSubType": "CREDIT",
"cardCategory": "GOLD"
},
"processingInfo": {
"processingStatus": "success",
"cvvResponseCode": "MA",
"avsResponseCodeZip": "U",
"avsResponseCodeAddress": "U",
"avsResponseCodeName": "U"
}
}
{
"cardTransactionType": "AUTH_ONLY",
"transactionId": "1012751937",
"softDescriptor": "BLS*DescTest",
"amount": 11,
"currency": "USD",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453"
},
"vaultedShopperId": 21289371,
"creditCard": {
"cardLastFourDigits": "9299",
"cardType": "VISA",
"cardSubType": "CREDIT",
"cardCategory": "CLASSIC"
},
"processingInfo": {
"processingStatus": "success"
}
}
{
"cardTransactionType": "AUTH_ONLY",
"transactionId": "1012751937",
"softDescriptor": "BLS*DescTest",
"amount": 11,
"currency": "USD",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453",
"country": "us"
},
"vaultedShopperId": 21289371,
"wallet": {
"walletType": "GOOGLE_PAY",
"billingContactInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453",
"country": "us"
},
"tokenizedCard": {
"cardLastFourDigits": "1111",
"cardType": "VISA",
"cardSubType": "CREDIT",
"dpanExpirationMonth": "9",
"dpanExpirationYear": "2025",
"dpanLastFourDigits": "2222"
}
},
"processingInfo": {
"processingStatus": "success"
}
}
{
"amount": 11,
"vaultedShopperId": 1234,
"processingInfo": {
"avsResponseCodeAddress": "M",
"processingStatus": "success",
"cvvResponseCode": "MA",
"authorizationCode": "654321",
"avsResponseCodeName": "U",
"avsResponseCodeZip": "M"
},
"softDescriptor": "BLS*DescTest",
"cardHolderInfo": {
"firstName": "test first name",
"lastName": "test last name",
"zip": "02453"
},
"currency": "USD",
"fraudResultInfo": {"deviceDataCollector": "Y"},
"creditCard": {
"cardLastFourDigits": 9299,
"cardSubType": "CREDIT",
"cardType": "VISA",
"cardCategory": "CLASSIC"
},
"cardTransactionType": "AUTH_ONLY",
"transactionId": 38488222
}
Note:
When you include the wallet ID in the request, a vaulted shopper will be automatically created and the vaulted shopper ID will be returned to you in the response.
If you prefer to save the wallet information in an existing shopper, it is recommended to instead send a Create Vaulted Shopper request with the wallet ID and then use that vaulted shopper in your Auth Only request.
Back to Top
API Explorer
To test out a basic API request, click the "Try It!" button in the right-hand column to test using the default, pre-populated sample values. To test with your own values, edit the parameter fields below. You'll see them populate in the right-hand column and you can click the "Try It!" button to submit your test request and see a response.