Auth Capture

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)

Request Content

Send a cardTransaction object, with the following:
     walletId     long    required if using Masterpass or 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
     merchantTransactionId     string    optional
     softDescriptor     string    optional
     descriptorPhoneNumber string    optional
     taxReference string    optional
     vendorsInfo object    required 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_CAPTURE
     threeDSecure     object    optional (refer to threeDSecure)
     transactionMetaData     object    optional (refer to transactionMetaData)
     pfToken     string    required if using Hosted Payment Fields, Embedded Checkout, or Secured Payment Collector
     level3Data     object    optional (refer to level3Data)
     storeCard     boolean    optional (refer to cardTransaction)
     networkTransactionInfo     container    optional (refer to networkTransactionInfo)
     transactionOrderSource     string    optional
     transactionInitiator     string    optional

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the request properties plus these additions:

      vaultedShopperId
     processingInfo
     fraudResultInfo if fraud prevention is enabled
     threeDSecure if sending 3D Secure authentication data
     networkTransactionInfo
     transactionId
     vendorsInfo if using marketplace vendor(s)
     level3Data if sending Level 2/3 data
     taxReference if including tax quote

Examples

Basic request and response examples

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": "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": 100,
  "softDescriptor": "DescTest",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "01003",
    "country": "US",
    "state": "MA"
  },
  "currency": "USD",
  "creditCard": {
    "expirationYear": "2023",
    "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": "2023",
    "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,
  "softDescriptor": "DescTest",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453"
  },
  "currency": "USD",
  "creditCard": {
    "expirationYear": "2023",
    "encryptedCardNumber": "$bsjs_1_0_3$B23uuxq8drUwOYZm3wZi+Qm69V5GPEt8PEio+Edwcm8akczQSK7odgLQH/Au+VqOCsGspW1Q9mPyQIzGLSZLVToAQVfq5C1ld+2ogIIsDL32Hd6IojboLyVlYT1FvPQoDyz19K6N0CUHh5uk0kCLuHSUyjvoJH38ojHZifbJSm/7S5vAtiuC3BJt2z8k9nauQaAXkbyoAYwrS1yDpqOt2k2lGhKcmdQ4ImDR0RL8m8xig6sFrki9oqo3Mju/M5r7wXXVTf7TMtWiQbzdfREOxKUnviXJZpncdHqVjj5GvPYun2qgopKVKr8F5+yd19TVW2gvA1kXBkXonFL9159Gxg==$zckJgo2i8jXDiAHwVVHBKypXFnWqF2e+6luBkmtQQRKniDXyXaalRVKLtYscBaGd$W7Ojqk1Q2iOJVeGL39RAsZTtfup3f1deSzvxrvC9rXA=",
    "encryptedSecurityCode": "$bsjs_1_0_3$MB1nBpok/YkuWPG1/7e6dyFFhDPHB8p8E9Yo+0YHHV+xkHuzFKr02wAnE8PJ8QCzWH+2ctXy5FN6wLKjwFrfTOgy0BJ9k9+NDEe8mhsu66wMlyc3lnwrbvMRCWN1O+5gUNCFExj7B0mDtf4gtxecXs74KZ5l5dbpGWdKUk5i7OewWyTqsONbn9taLfVBOwuIOy2Jgi4fx+yB8Q05KdZeHSNSBJh8H/47AUNAn5dM+d9iO6yGQB3obzEzzR3UtHlkGR52ZsgbbFh0JMm9lBM2ClgYM8jvmQjS9HX2ojt1fkbhuPEb1IY/M498a+1wDPpI4aMfDxO1lSpJneRSpY5k4g==$XaKq1NbPcS0iHy9N9jHekEIByHYS4G3wJXlC9EQjAGM=$BJn6X6mBYGUo8Eoq4RQz69gsi4Azl8jT973mNpG9Yuo=",
    "expirationMonth": "07"
  },
  "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,
  "merchantTransactionId": "31233",
  "softDescriptor": "DescTest",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453",
    "merchantShopperId": "a432512"
  },
  "currency": "USD",
  "creditCard": {
    "expirationYear": "2023",
    "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": "2023",
    "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": "2023",
    "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": "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 '
{
  "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": "2023"
  }
}'

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/2020",
  "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": {}
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "1035511971",
  "softDescriptor": "BLS*DescTest",
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2020",
  "transactionApprovalTime": "13:16:27",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name",
    "zip": "02453"
  },
  "vaultedShopperId": 28855215,
  "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": {}
}

{
  "amount": 11,
  "usdAmount": 11,
  "currency": "USD",
  "transactionApprovalDate": "09/29/2020",
  "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/2020",
  "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/2020",
  "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/2020",
  "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/2020",
  "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/2020",
  "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"
}

Fraud request and response examples

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": 12345,
      "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_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": "2023",
    "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/2020",
  "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": "2023",
    "issuingCountryCode": "ie"
  },
  "processingInfo": {
    "processingStatus": "success",
    "cvvResponseCode": "MA",
    "authorizationCode": "123456",
    "avsResponseCodeZip": "U",
    "avsResponseCodeAddress": "U",
    "avsResponseCodeName": "U"
  },
  "fraudResultInfo": {}
}

Vaulted Shopper request and response examples

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": "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 '
{
  "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/2020",
  "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/2020",
  "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/2020",
  "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": {}
}

Wallet request and response examples

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/2020",
  "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/2020",
  "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": "2019",
      "dpanLastFourDigits": "0010",
      "cardLastFourDigits": "1471",
      "cardType": "MASTERCARD",
      "cardSubType": "DEBIT",
      "binCategory": "CONSUMER",
      "cardRegulated": "N",
      "issuingCountryCode": "us"
    }
  },
  "processingInfo": {
    "processingStatus": "success"
  }
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "1012751937",
  "softDescriptor": "BLS&#x2a;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": "10027"
  },
  "vaultedShopperId": 21289371,
  "creditCard": {
    "cardLastFourDigits": "9299",
    "cardType": "VISA",
    "cardSubType": "CREDIT",
    "cardCategory": "CLASSIC"
  },
  "processingInfo": {
    "processingStatus": "success"
  }
}

{
  "cardTransactionType": "AUTH_CAPTURE",
  "transactionId": "1012751937",
  "softDescriptor": "BLS&#x2a;DescTest",
  "amount": 11,
  "currency": "USD",
  "usdAmount": 11,
  "transactionApprovalDate": "09/29/2020",
  "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": "2025",
      "dpanLastFourDigits": "2222"
    }
  },
  "processingInfo": {
    "processingStatus": "success"
  }
}

3-D Secure request and response examples

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":"2023"
  },
  "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": "2023",
    "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/2020",
  "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/2020",
  "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/2020",
  "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/2020",
  "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"
  }
}

Example Descriptions

Basic

Auth Capture with metadata

To send metadata for the transaction, you'll need to include the transactionMetaData property within the cardTransaction object. You can include up to 20 metadata key-value pairs in each transactionMetaData property.

Above is an example of a request with metadata, including state tax, city tax, and the shipping amount.

Auth Capture with Merchant Transaction ID

You may wish to assign your own ID to each transaction, for example in order to track the transactions in your own internal systems. To do this, you'll need to include the merchantTransactionId property within the cardTransaction object.

Above is an example of a request that includes a Merchant Transaction ID (MTI), along with the minimum required fields for a one-time payment using a credit card.

Auth Capture with encrypted credit card

Your PCI compliance requirements and API permission level may require that you send credit card data in encrypted format only. To do this, you'll need to include theencryptedCardNumber and encryptedSecurityCode properties within the cardTransaction object.

Above is an example of a request with an encrypted credit card number.

Auth Capture with Hosted Payment Fields token

If you are using BlueSnap's Hosted Payment Fields, you can process the shopper's payment using the information from the Hosted Payment Fields by including the token within the pfToken property in your request.

Above is an example of a request with the Hosted Payment Fields token.

Note that the response looks like a regular response for a credit card, with the card's last four digits and card type.

Auth Capture with Merchant Shopper ID

You may wish to assign your own Shopper ID to each transaction, for example in order to track the transactions in your own internal systems. To do this, you'll need to include the merchantShopperId property within the cardTransaction object.

Above is an example of a request that includes a Merchant Shopper ID, along with the minimum required fields for a one-time payment using a credit card.

Auth Capture with Vendors Info

This example shows an Auth Capture request within a marketplace. If you are a Marketplace Merchant, include vendorsInfo in the request to process a transaction involving one or more vendors. For more details, refer to the Marketplace Guide.

Auth Capture with store card approval

This example shows an Auth Capture request with the storeCard value set. You want to use this value to define if the shopper has approved storing their credit card information for future use. The default value is set to true. If set to false, the credit card data is not stored.

Auth Capture with Embedded Checkout token

If you are using BlueSnap's Embedded Checkout, you can process the shopper's payment using the information from the Embedded Payment Form by including the token within the pfToken property in your request.

Above is an example of a request with the Embedded Checkout token.

Note: The response looks like a regular response for a credit card, with the card's last four digits and card type.

Auth Capture with tax quote

This example shows an Auth Capture request with the taxReference property set. You will use this property if you have implemented BlueSnap's tax feature and want to process transactions including tax. First, you will need to map your products to tax codes. Then as part of the checkout process, you will create a tax quote for a transaction, which will return total tax and the tax quote reference number. As part of Auth Capture, you will send the tax quote reference number in taxReference and total transaction amount, including tax, in amount.

Fraud Examples

Auth Capture with fraud info

This example shows a basic Auth Capture request, containing the minimum required fields for a one-time payment using a credit card. It includes the required fraud info in the transactionFraudInfo property within the cardTransaction object. Refer to transactionFraudInfo.

An additional example with Complete-level (formerly Enterprise) fraud info is above. Complete-level fraud info is supported only for merchants who have signed up for the Complete-level fraud service from BlueSnap. Refer to Fraud prevention.

Vaulted Shopper Examples

Auth Capture with vaulted shopper

To perform an Auth Capture request with an existing vaulted shopper, you'll need to include the vaultedShopperId property within the cardTransaction object. When specifying a credit card for a vaulted shopper, you must include the cardLastFourDigits and cardType properties within the creditCard object.

Above are two vaulted shopper examples. The first is with a vaulted shopper who only has one credit card, so there is no need to specify which credit card to charge. The second is with a vaulted shopper who has multiple cards, so the request must indicate which card to charge.

Auth Capture with vaulted shopper & CVV

You may wish to collect CVV on your checkout form from all your shoppers – even from returning shoppers. One reason you might choose to do this is that transactions with CVV generally result in higher success rates.

Above is an example of sending CVV in a transaction request involving a returning shopper.
Include vaultedShopperId and CVV in the request as in the example.

Auth Capture with vaulted shopper & new card

This example shows an Auth Capture request with a vaulted shopper and a new card. If you include vaultedShopperId and a new card in the request, the shopper's card will be charged and the card details will be added to the shopper.

Auth Capture with vaulted shopper & tokenized CVV

This example shows an Auth Capture request with a vaulted shopper and a tokenized CVV. You may wish to collect CVV on your checkout form for returning shoppers since transactions with CVV generally result in higher success rates. See the Hosted Payment Fields guide for details on how to tokenize card data.

Wallet Examples

Auth Capture with wallet ID

If the shopper is paying via Masterpass or Visa Checkout, you can include the walletId in the request. For details, refer to:

Above is an example of a request with a Masterpass wallet.

📘
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.

Auth Capture with Apple Pay

This example shows an Auth Capture request with Apple Pay. In the request, include walletType = APPLE_PAY and encodedPaymentToken inside wallet. Instructions on how to extract the encodedPaymentToken can be found in the Apple Pay Guide.

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

Auth Capture with Google Pay

This example shows an Auth Capture request with Google Pay™. In the request, include walletType = GOOGLE_PAY and encodedPaymentToken inside wallet. Instructions on how to extract the encodedPaymentToken can be found in the Google Pay Guide.

3-D Secure Examples

3DS with shopper-initiated transaction

The request includes "transactionInitiator":"SHOPPER" to indicate that this is a Customer-Initiated Transaction. The response includes the same networkTransactionId in both the networkTransactionInfo and the processingInfo sections. The merchant keeps this networkTransactionId for future transactions.

3DS with MIT

The request includes "transactionInitiator":"MERCHANT" to indicate that this is a Merchant-Initiated Transaction. The merchant also includes the originalNetworkTransactionId to link the transaction to an existing transaction on which SCA was performed so SCA does not need to be performed again. In the networkTransactionInfo section, the response includes both the originalNetworkTransactionId and the new networkTransactionId. The merchant continues using the originalNetworkTransactionId for future transactions.

Returning shopper with 3DS

This request specifies the vaultedShopperId, the card details rather than the token, and includes the threeDSecureReferenceId to link everything together. The threeDSecureReferenceId comes from sdkResponse.threeDSecure.threeDSecureReferenceId in the callback of bluesnap.threeDsPaymentsSetup. For more information, refer to the 3-D Secure for API Guide.

With MOTO and NTI

This request specifies the "transactionOrderSource":"MOTO" indicating that this is a MOTO transaction. The response includes the same networkTransactionId in both the networkTransactionInfo and the processingInfo sections. The merchant keeps this networkTransactionId for future transactions. For more information, refer to the 3-D Secure for API Guide.

3DS with External MPI

The request includes the threeDSecure object to provide the necessary 3-D Secure data from the external Merchant Plug-In (MPI).

API Explorer

To test out a call, enter the request content below and then click Try it!

📘
Tip
Use the JSON code below as a starting point. You can enter different parameters and test credit card numbers to see how your test scenario would work. The request headers, including authorization, are already built in for you in this test area, so you should not include them here.

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

Request Content

Response Details

Examples

Basic request and response examples

Fraud request and response examples

Vaulted Shopper request and response examples

Wallet request and response examples

3-D Secure request and response examples

Example Descriptions

Basic

Auth Capture with metadata

Auth Capture with Merchant Transaction ID

Auth Capture with encrypted credit card

Auth Capture with Hosted Payment Fields token

Auth Capture with Merchant Shopper ID

Auth Capture with Vendors Info

Auth Capture with store card approval

Auth Capture with Embedded Checkout token

Auth Capture with tax quote

Fraud Examples

Auth Capture with fraud info

Vaulted Shopper Examples

Auth Capture with vaulted shopper

Auth Capture with vaulted shopper & CVV

Auth Capture with vaulted shopper & new card

Auth Capture with vaulted shopper & tokenized CVV

Wallet Examples

Auth Capture with wallet ID

📘Note

Auth Capture with Apple Pay

📘Note

Auth Capture with Google Pay

3-D Secure Examples

3DS with shopper-initiated transaction

3DS with MIT

Returning shopper with 3DS

With MOTO and NTI

3DS with External MPI

API Explorer

📘Tip

📘
Note

📘
Note

📘
Tip