BlueSnap.comAPI BasicsPayment APIEmbedded PaymentsReporting & ToolsSupport Guides

Auth Capture

post https://sandbox.bluesnap.com/services/2/transactions

Auth Capture performs two actions via a single request:

  • authorize: checks whether a credit card is valid and has the funds to complete a specific transaction (a purchase)
  • capture: submits the authorized transaction for settlement (a payment by the shopper)

📘

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:

PropertyTypeRequired
walletIdlongrequired if using Masterpass or Visa Checkout
walletobjectrequired if using Apple Pay or Google Pay™ (refer to wallet)
amountdecimalrequired
vaultedShopperIdintegerrequired if using a vaulted shopper
merchantTransactionIdstringoptional
softDescriptorstringoptional
descriptorPhoneNumberstringoptional
taxReferencestringoptional
vendorsInfoobjectrequired if using marketplace vendor(s) (refer to vendorsInfo)
cardHolderInfoobjectrequired for LatAm local processing (refer to cardHolderInfo)
currencystringrequired
transactionFraudInfoobjectoptional (refer to transactionFraudInfo)
creditCardobjectrequired if sending card data or if vaulted shopper has multiple cards. Do not include if sending pfToken or wallet (refer to creditCard)
cardTransactionTypestringrequired, value must be AUTH_CAPTURE
threeDSecureobjectoptional (refer to threeDSecure)
transactionMetaDataobjectoptional (refer to transactionMetaData)
pfTokenstringrequired if using Hosted Payment Fields, Embedded Checkout, or Secured Payment Collector
level3Dataobjectoptional (refer to level3Data)
storeCardbooleanoptional (refer to cardTransaction)
networkTransactionInfocontaineroptional (refer to networkTransactionInfo)
transactionOrderSourcestringoptional
transactionInitiatorstringoptional

📘

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:

PropertyIncluded in response if
vaultedShopperId
processingInfo
fraudResultInfofraud prevention is enabled
threeDSecuresending 3D Secure authentication data
networkTransactionInfo
transactionId
vendorsInfousing marketplace vendor(s)
level3Dataif sending Level 2/3 data
taxReferenceif including tax quote

Back to Top

Request and Response Examples

Basic

Request

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_CAPTURE",
  "softDescriptor": "DescTest",
  "amount": "11.00",
  "currency": "USD",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453"
  },
  "creditCard": {
    "cardNumber": "4263982640269299",
    "securityCode": "837",
    "expirationMonth": "02",
    "expirationYear": "2026"
  }
}'

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": 100,
  "softDescriptor": "DescTest",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "01003",
    "country": "US",
    "state": "MA"
  },
  "currency": "USD",
  "creditCard": {
    "expirationYear": "2026",
    "securityCode": "111",
    "expirationMonth": "02",
    "cardNumber": "4263982640269299"
  },
  "cardTransactionType": "AUTH_CAPTURE",
  "vendorsInfo": {
    "vendorInfo": [{ "vendorId": 10398032 }]
  }
}'

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": "2026",
    "securityCode": "837",
    "expirationMonth": "02",
    "cardNumber": 4263982640269299
  },
  "cardTransactionType": "AUTH_CAPTURE",
  "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,
  "merchantTransactionId": "31233",
  "softDescriptor": "DescTest",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453",
    "merchantShopperId": "a432512"
  },
  "currency": "USD",
  "creditCard": {
    "expirationYear": "2026",
    "securityCode": "837",
    "expirationMonth": "02",
    "cardNumber": 4263982640269299
  },
  "cardTransactionType": "AUTH_CAPTURE"
}'

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_CAPTURE",
  "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,
  "merchantTransactionId": 3,
  "softDescriptor": "DescTest",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453"
  },
  "currency": "USD",
  "creditCard": {
    "expirationYear": "2026",
    "securityCode": "837",
    "expirationMonth": "02",
    "cardNumber": 4263982640269299
  },
  "cardTransactionType": "AUTH_CAPTURE"
}'

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",
  "currency": "USD",
  "cardTransactionType": "AUTH_CAPTURE",
  "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",
  "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": "2026",
    "securityCode": "837",
    "expirationMonth": "02",
    "cardNumber": 4263982640269299
  },
  "cardTransactionType": "AUTH_CAPTURE",
  "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_CAPTURE",
  "softDescriptor": "DescTest",
  "transactionOrderSource": "MOTO",
  "amount": 11,
  "currency": "USD",
  "cardHolderInfo": {
    "firstName": "Will",
    "lastName": "Smith"
  },
  "creditCard": {
    "cardNumber": "4012000033330026",
    "securityCode": "123",
    "expirationMonth": "07",
    "expirationYear": "2026"
  }
}'

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_CAPTURE",
  "softDescriptor": "Test transaction",
  "amount": 174.8,
  "currency": "USD",
  "taxReference": "048deff0-a285-47e1-bc39-42f79bf0095b",
  "cardHolderInfo": {
    "firstName": "Jane",
    "lastName": "Smith",
    "zip": "02453",
    "country": "us"
  },
  "creditCard": {
    "cardNumber": "4263982640269299",
    "securityCode": "837",
    "expirationMonth": "02",
    "expirationYear": "2026"
  }
}'

Response 

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "1035511869",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2020",
  "transactionApprovalTime": "13:08:47",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453"
  },
  "vaultedShopperId": 28855193,
  "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": "123456",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U"
  },
  "fraudResultInfo": {}
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "vendorInfo": {
    "vendorId": 10398032,
    "commissionPercent": 90.2
  },
  "vendorsInfo": {
    "vendorInfo": [
      {
        "vendorId": 10398032,
        "commissionPercent": 90.2
      }
    ]
  },
  "transactionId": "1035511531",
  "softDescriptor": "BLS*DescTest",
  "amount": 100,
  "usdAmount": 100,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2020",
  "transactionApprovalTime": "13:11:56",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "country": "US",
    "state": "MA",
    "zip": "01003"
  },
  "vaultedShopperId": 28855203,
  "creditCard": {
    "cardLastFourDigits": "9299",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "cardCategory": "PLATINUM",
    "binCategory": "CONSUMER",
    "cardRegulated": "N",
    "issuingBank": "ALLIED IRISH BANKS PLC",
    "issuingCountryCode": "ie"
  },
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "ND",
    "authorizationCode": "654321",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U"
  },
  "fraudResultInfo": {}
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "1035511881",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2020",
  "transactionApprovalTime": "13:14:14",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453"
  },
  "vaultedShopperId": 28855211,
  "creditCard": {
    "cardLastFourDigits": "9299",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "cardCategory": "PLATINUM",
    "binCategory": "CONSUMER",
    "cardRegulated": "N",
    "issuingBank": "ALLIED IRISH BANKS PLC",
    "issuingCountryCode": "ie"
  },
  "transactionMetaData": {
    "metaData": [
      {
        "metaKey": "stateTaxAmount",
        "metaValue": "20",
        "metaDescription": "State Tax Amount"
      },
      {
        "metaKey": "cityTaxAmount",
        "metaValue": "20",
        "metaDescription": "City Tax Amount"
      },
      {
        "metaKey": "shippingAmount",
        "metaValue": "10",
        "metaDescription": "Shipping Amount"
      }
    ]
  },
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "MA",
    "authorizationCode": "123456",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U"
  },
  "fraudResultInfo": {}
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "merchantTransactionId": "3",
  "transactionId": "1035511807",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:23:19",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453"
  },
  "vaultedShopperId": 28855261,
  "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": "123456",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U"
  },
  "fraudResultInfo": {}
}

{
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:16:27",
  "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"
  },
  "creditCard": {
    "cardLastFourDigits": 9299,
    "cardSubType": "CREDIT",
    "cardType": "VISA",
    "cardCategory": "CLASSIC"
  },
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": 38486450
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "merchantTransactionId": "31233",
  "transactionId": "1035511537",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:17:56",
  "cardHolderInfo": {
    "merchantShopperId": "a432512",
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453"
  },
  "vaultedShopperId": 28855219,
  "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": "123456",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U"
  },
  "fraudResultInfo": {}
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "1035511921",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:27:14",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453"
  },
  "vaultedShopperId": 28855295,
  "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": "123456",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U"
  },
  "fraudResultInfo": {}
}

{
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:11:56",
  "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"
  },
  "creditCard": {
    "cardLastFourDigits": 9299,
    "cardSubType": "CREDIT",
    "cardType": "VISA",
    "cardCategory": "CLASSIC"
  },
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": 38486450
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "38486450",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "currency": "USD",
  "usdAmount": 11,
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:11:56",
  "vaultedShopperId": "1234",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453"
  },
  "creditCard": {
    "cardLastFourDigits": "9299",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "cardCategory": "CLASSIC"
  },
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "MA",
    "authorizationCode": "654321",
    "avsResponseCodeZip": "M",
    "avsResponseCodeAddress": "M",
    "avsResponseCodeName": "U"
  }
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "38646818",
  "softDescriptor": "Test transaction",
  "amount": 174.8,
  "usdAmount": 174.8,
  "currency": "USD",
  "avsResponseCode": "N",
  "transactionApprovalDate": "08/26/2022",
  "transactionApprovalTime": "01:17:01",
  "cardHolderInfo": {
    "firstName": "Jane",
    "lastName": "Smith",
    "country": "us",
    "zip": "92614"
  },
  "vaultedShopperId": 19671044,
  "creditCard": {
    "cardLastFourDigits": "9299",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "cardCategory": "PLATINUM",
    "binCategory": "CONSUMER",
    "issuingBank": "ALLIED IRISH BANKS PLC",
    "issuingCountryCode": "ie"
  },
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "NR",
    "authorizationCode": "587327",
    "avsResponseCodeZip": "N",
    "avsResponseCodeAddress": "N",
    "avsResponseCodeName": "U"
  },
  "fraudResultInfo": {
    "deviceDataCollector": "N"
  },
  "taxReference": "048deff0-a285-47e1-bc39-42f79bf0095b"
}

Back to Top

Fraud

Request

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",
    "fraudProducts": [
      {
        "fraudProductName": "123RRC",
        "fraudProductDesc": "my product",
        "fraudProductType": "Online game",
        "fraudProductQuantity": 1,
        "fraudProductPrice": 14.5
      },
      {
        "fraudProductName": "345RRC",
        "fraudProductDesc": "my product2",
        "fraudProductType": "Video game",
        "fraudProductQuantity": 2,
        "fraudProductPrice": 18
      }
    ],
    "shippingContactInfo": {
      "zip": "02453",
      "country": "US",
      "firstName": "YY",
      "lastName": "LL",
      "city": "Juneau",
      "address2": "Address2",
      "address1": "Address1",
      "state": "AL"
    }
  },
  "creditCard": {
    "expirationYear": "2026",
    "securityCode": "837",
    "expirationMonth": "02",
    "cardNumber": 4263982640269299
  },
  "cardTransactionType": "AUTH_CAPTURE"
}'

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",
    "customerId": "121341",
    "customerCreationDate": "2021-08-05"
    "fraudSessionId": 1234,
    "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": "2026",
    "securityCode": "837",
    "expirationMonth": "02",
    "cardNumber": 4263982640269299
  },
  "cardTransactionType": "AUTH_CAPTURE"
}'

Response

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "1039090313",
  "softDescriptor": "BLS*DescTest",
  "amount": 11.0,
  "usdAmount": 11.0,
  "currency": "USD",
  "transactionApprovalDate": "12/28/2022",
  "transactionApprovalTime": "15:04:33",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453"
  },
  "vaultedShopperId": 29969891,
  "creditCard": {
    "cardLastFourDigits": "9299",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "cardCategory": "PLATINUM",
    "binCategory": "CONSUMER",
    "binNumber": "426398",
    "cardRegulated": "N",
    "issuingBank": "ALLIED IRISH BANKS PLC",
    "expirationMonth": "02",
    "expirationYear": "2026",
    "issuingCountryCode": "ie"
  },
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "MA",
    "authorizationCode": "123456",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U"
  },
  "fraudResultInfo": {}
}

Back to Top

Vaulted Shopper

Request

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": "1111",
    "cardType": "VISA"
  },
  "cardTransactionType": "AUTH_CAPTURE"
}'

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_CAPTURE"
}'

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": "1111",
    "cardType": "VISA",
    "securityCode": "837"
  },
  "cardTransactionType": "AUTH_CAPTURE"
}'

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_CAPTURE",
  "softDescriptor": "DescTest",
  "amount": "11.00",
  "currency": "USD",
  "vaultedShopperId": "20769005",
  "creditCard": {
    "cardNumber": "4012000033330026",
    "securityCode": "111",
    "expirationMonth": "07",
    "expirationYear": "2026"
  }
}'

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_CAPTURE",
  "softDescriptor": "DescTest",
  "amount": 10,
  "currency": "USD",
  "vaultedShopperId": "29034019",
  "creditCard": {
    "cardLastFourDigits": "1000",
    "cardType": "VISA",
    "securityCodePfToken": "0183117d722d8cc9921b4d5710d3394162c6d54d2b2cc1ed1f682e6c0618b7c5"
  }
}'

Response

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "1035512125",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:34:16",
  "vaultedShopperId": 20769005,
  "creditCard": {
    "cardLastFourDigits": "1111",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "binCategory": "CONSUMER",
    "cardRegulated": "Y",
    "issuingBank": "JPMORGAN CHASE BANK, N.A.",
    "issuingCountryCode": "us"
  },
  "processingInfo": {
    "processingStatus": "success",
    "authorizationCode": "654321",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U"
  },
  "fraudResultInfo": {}
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "1035512361",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:37:15",
  "vaultedShopperId": 20769005,
  "creditCard": {
    "cardLastFourDigits": "1111",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "binCategory": "CONSUMER",
    "cardRegulated": "Y",
    "issuingBank": "JPMORGAN CHASE BANK, N.A.",
    "issuingCountryCode": "us"
  },
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "ND",
    "authorizationCode": "654321",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U"
  },
  "fraudResultInfo": {}
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "1035512275",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:38:45",
  "vaultedShopperId": 20769005,
  "creditCard": {
    "cardLastFourDigits": "0026",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "cardCategory": "CLASSIC",
    "binCategory": "CONSUMER",
    "cardRegulated": "N",
    "issuingCountryCode": "ru"
  },
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "ND",
    "authorizationCode": "654321",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U"
  },
  "fraudResultInfo": {}
}

Back to Top

Wallet

Request

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_CAPTURE"
}'

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_CAPTURE",
  "softDescriptor": "DescTest",
  "amount": 11.0,
  "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 '
{
  "cardTransactionType": "AUTH_CAPTURE",
  "softDescriptor": "DescTest",
  "amount": 11.0,
  "currency": "USD",
  "wallet": {
    "walletType": "GOOGLE_PAY",
    "encodedPaymentToken": "ImRhdGEiOiJuY1AvRitIUy8zeG5bXhCMFd"
  }
}'

Response

{
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:08:47",
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "NC"
  },
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name"
  },
  "creditCard": {
    "cardLastFourDigits": 9299,
    "cardSubType": "CREDIT",
    "cardType": "VISA",
    "cardCategory": "CLASSIC"
  },
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": 1011702615
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "merchantTransactionId": "112233",
  "transactionId": "38602972",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "currency": "USD",
  "usdAmount": 11,
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:08:47",
  "cardHolderInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "country": "us",
    "state": "NY",
    "address": "61 Main St.",
    "city": "New York",
    "zip": "10027",
    "phone": "222513654654"
  },
  "vaultedShopperId": 19644934,
  "wallet": {
    "walletType": "APPLE_PAY",
    "billingContactInfo": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "61 Main St.",
      "city": "New York",
      "state": "NY",
      "zip": "10027",
      "country": "us"
    },
    "tokenizedCard": {
      "dpanExpirationMonth": "7",
      "dpanExpirationYear": "2026",
      "dpanLastFourDigits": "0010",
      "cardLastFourDigits": "1471",
      "cardType": "MASTERCARD",
      "cardSubType": "DEBIT",
      "binCategory": "CONSUMER",
      "cardRegulated": "N",
      "issuingCountryCode": "us"
    }
  },
  "processingInfo": {
    "processingStatus": "success"
  }
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "1012751937",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:08:47",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "10027"
  },
  "vaultedShopperId": 21289371,
  "creditCard": {
    "cardLastFourDigits": "9299",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "cardCategory": "CLASSIC"
  },
  "processingInfo": {
    "processingStatus": "success"
  }
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "1012751937",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "currency": "USD",
  "usdAmount": 11,
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:08:47",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "10027",
    "country": "us"
  },
  "vaultedShopperId": 21289371,
  "wallet": {
    "walletType": "GOOGLE_PAY",
    "billingContactInfo": {
      "firstName": "test first name",
      "lastName": "test last name",
      "zip": "10027",
      "country": "us"
    },
    "tokenizedCard": {
      "cardLastFourDigits": "1111",
      "cardType": "VISA",
      "cardSubType": "CREDIT",
      "dpanExpirationMonth": "9",
      "dpanExpirationYear": "2026",
      "dpanLastFourDigits": "2222"
    }
  },
  "processingInfo": {
    "processingStatus": "success"
  }
}

📘

Note

To test Apple Pay, follow the steps in the Apple Pay Guide. The API Explorer does not support Apple Pay testing.

Back to Top

3-D Secure

Request

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": 10.0,
  "softDescriptor": "DescTest",
  "currency": "USD",
  "cardHolderInfo": {
    "firstName": "Will",
    "lastName": "Smith"
  },
  "pfToken": "124ed4af4a7530e1a5f6359c3120cde7b05260d792a3aeed38acd098046846af_",
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionInitiator": "SHOPPER"
}'

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": 25.0,
  "softDescriptor": "DescTest",
  "currency": "USD",
  "vaultedShopperId": 19574632,
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionInitiator": "MERCHANT",
  "networkTransactionInfo": {
    "originalNetworkTransactionId": "019072416113666"
  }
}'

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_CAPTURE",
	"softDescriptor": "DescTest",
	"amount": 10,
	"currency": "USD",
	"vaultedShopperId":"19574268",
	"creditCard": {
		"cardLastFourDigits": "1111",
		"cardType": "VISA"
		},
	"threeDSecure": {
		"threeDSecureReferenceId":"5303"
	}
}'

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_CAPTURE",
  "recurringTransaction": "ECOMMERCE",
  "softDescriptor": "DescTest",
  "amount": 10,
  "currency": "USD",
  "cardHolderInfo": {
    "firstName": "Will",
    "lastName": "Smith"
  },
  "creditCard": {
    "cardNumber": "4012000033330026",
    "securityCode": "123",
    "expirationMonth": "07",
    "expirationYear":"2026"
  },
  "threeDSecure": {
  	"threeDSecureReferenceId":"4759"
  }
}'

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": "2026",
    "securityCode": "111",
    "expirationMonth": "07",
    "cardNumber": 4012000033330026
  },
  "cardTransactionType": "AUTH_CAPTURE",
  "threeDSecure": {
    "eci": "05",
    "cavv": "AAABAWFlmQAAAABjRWWZEEFgFz+A",
    "xid": "MGpHWm5ZWVpKclo0aUk0VmltVDA=",
     "dsTransactionId" : "e08da266-b58d-45c9-a1f8-570b7fb80e30",
     "threeDSecureVersion" : "2.1.0"
  }
}

Response

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "38510976",
  "softDescriptor": "BLS*DescTest",
  "amount": 10,
  "usdAmount": 10,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:08:47",
  "avsResponseCode": "G",
  "cardHolderInfo": {
    "firstName": "Will",
    "lastName": "Smith"
  },
  "vaultedShopperId": 19574632,
  "creditCard": {
    "cardLastFourDigits": "1000",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "binCategory": "CONSUMER",
    "issuingCountryCode": "us"
  },
  "threeDSecure": {
    "authenticationResult": "AUTHENTICATION_SUCCEEDED"
  },
  "networkTransactionInfo": {
    "originalNetworkTransactionId": "019072416113666",
    "networkTransactionId": "019072416144666"
  },
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "NR",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U",
    "networkTransactionId": "019072416113666"
  }
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "38510978",
  "softDescriptor": "BLS*DescTest",
  "amount": 25,
  "usdAmount": 25,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:08:47",
  "avsResponseCode": "G",
  "vaultedShopperId": 19574632,
  "creditCard": {
    "cardLastFourDigits": "1000",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "binCategory": "CONSUMER",
    "issuingCountryCode": "us"
  },
  "networkTransactionInfo": {
    "originalNetworkTransactionId": "019072416113666",
    "networkTransactionId": "019072416144666"
  },
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "ND",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U",
    "networkTransactionId": "019072416144666"
  },
  "fraudResultInfo": {
    "deviceDataCollector": "N"
  }
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "38511274",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:08:47",
  "avsResponseCode": "G",
  "cardHolderInfo": {
    "firstName": "Will",
    "lastName": "Smith"
  },
  "vaultedShopperId": 19574800,
  "creditCard": {
    "cardLastFourDigits": "0026",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "cardCategory": "CLASSIC",
    "binCategory": "CONSUMER",
    "issuingBank": "EXTRAS TEST - VISA",
    "issuingCountryCode": "us"
  },
  "networkTransactionInfo": {
    "originalNetworkTransactionId": "019072416113666",
    "networkTransactionId": "019072416144666"
  },
  "transactionOrderSource": "MOTO",
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "NR",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U",
    "networkTransactionId": "759211612041880"
  },
  "fraudResultInfo": {
    "deviceDataCollector": "N"
  }
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "38510954",
  "recurringTransaction": "ECOMMERCE",
  "softDescriptor": "BLS*DescTest",
  "amount": 10,
  "usdAmount": 10,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2022",
  "transactionApprovalTime": "13:08:47",
  "avsResponseCode": "G",
  "cardHolderInfo": {
    "firstName": "Will",
    "lastName": "Smith"
  },
  "vaultedShopperId": 19574620,
  "creditCard": {
    "cardLastFourDigits": "0026",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "cardCategory": "CLASSIC",
    "binCategory": "CONSUMER",
    "issuingBank": "EXTRAS TEST - VISA",
    "issuingCountryCode": "us"
  },
  "threeDSecure": {
    "authenticationResult": "AUTHENTICATION_SUCCEEDED"
  },
  "networkTransactionInfo": {
    "originalNetworkTransactionId": "019072416113666",
    "networkTransactionId": "019072416144666"
  },
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "MA",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U",
    "networkTransactionId": "759205708034420"
  },
  "fraudResultInfo": {
    "deviceDataCollector": "N"
  }
}

📘

Note

When you include the wallet ID in the request, a vaulted shopper is automatically created and the vaulted shopper ID is returned 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 Capture 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.

Language
Authorization
Header
Click Try It! to start a request and see the response here!