At BlueSnap, we look at payments a little differently. Our Payment Orchestration Platform helps businesses accept payments globally and is designed to increase revenue and reduces costs. We provide a comprehensive back-end solutions that simplifies the complexity of payments, managing the full process from start to finish.
BlueSnap supports payments through multiple sales channels such as online and mobile sales, marketplaces, subscriptions, invoice payments and manual orders through a virtual terminal. And for businesses looking for embedded payments, we offer white-labeled payments for platforms with automated underwriting and onboarding that supports marketplaces and split payments.
And with one integration and contract, businesses can sell in over 200 geographies with access to local acquiring in 47 countries, 110+ currencies and 100+ global payment types, including popular eWallets, automated accounts receivable, world-class fraud protection and chargeback management, built-in solutions for regulation and tax compliance, and unified global reporting to help businesses grow.
With a US headquarters in Waltham, MA, and EU headquarters in Dublin, Ireland, BlueSnap is backed by world-class private equity investors including Great Hill Partners and Parthenon Capital Partners.
Learn more at BlueSnap.com
- Installation
- Getting Started
- Reference
bluesnap.agreement.createDebitForAusCanbluesnap.agreement.getDebitbluesnap.authorization.createTransactionbluesnap.plan.createRecurringPlanbluesnap.plan.getAllbluesnap.plan.getSpecificbluesnap.plan.updateRecurringPlanbluesnap.reversal.authTransactionbluesnap.shopper.createVaultedShopperbluesnap.shopper.deleteVaultedShopperbluesnap.shopper.getbluesnap.shopper.updateVaultedShopperbluesnap.subscription.createMerchantManagedChargebluesnap.subscription.createMerchantManagedSubscriptionbluesnap.subscription.createNewbluesnap.subscription.getSpecificbluesnap.subscription.getSwitchChargeAmountbluesnap.subscription.listAllSubscriptionsbluesnap.subscription.listChargesbluesnap.subscription.updateSubscriptionbluesnap.transaction.approveMerchantTransactionbluesnap.transaction.cancelPendingRefundbluesnap.transaction.createBatchTransactionbluesnap.transaction.createSofortTransactionbluesnap.transaction.getBatchTransactionbluesnap.transaction.getByIdbluesnap.transaction.getPaypalTransactionbluesnap.transaction.getPreNotificationDebitAgreementbluesnap.transaction.getSepaDdbluesnap.transaction.getSofortTransactionbluesnap.transaction.initiateRefundbluesnap.transaction.updatePaypalTransactionbluesnap.vendor.createbluesnap.vendor.getAllVendorsbluesnap.vendor.getVendorbluesnap.vendor.updateVendor
import { BlueSnap } from "blue-snap-typescript-sdk";
const bluesnap = new BlueSnap({
// Defining the base path is optional and defaults to https://sandbox.bluesnap.com/services/2
// basePath: "https://sandbox.bluesnap.com/services/2",
apiKey: "API_KEY",
});
const createDebitForAusCanResponse =
await bluesnap.agreement.createDebitForAusCan({
region: "ca",
type: "onetime",
});
console.log(createDebitForAusCanResponse);for Australia and Canada
const createDebitForAusCanResponse =
await bluesnap.agreement.createDebitForAusCan({
region: "ca",
type: "onetime",
});Represents the country. Possible Values: au, ca
Represents the mandate type. Possible Values: onetime,recurring, ondemand
SKU number
the amount which overrides recurring charge
/agreements/debit/{region}/{type} POST
for Australia and Canada
const getDebitResponse = await bluesnap.agreement.getDebit({
agreementId: "1065",
});Argument included in the response for the Create Debit Agreement request
/agreements/{agreementId} GET
const createTransactionResponse =
await bluesnap.authorization.createTransaction({
amount: 11,
softDescriptor: "DescTest",
currency: "USD",
cardTransactionType: "AUTH_ONLY",
});cardHolderInfo: AuthorizationCreateTransactionRequestCardHolderInfo
creditCard: AuthorizationCreateTransactionRequestCreditCard
/transactions POST
const createRecurringPlanResponse = await bluesnap.plan.createRecurringPlan({
chargeFrequency: "MONTHLY",
gracePeriodDays: 10,
trialPeriodDays: 14,
initialChargeAmount: 100,
name: "Gold Plan",
currency: "USD",
maxNumberOfCharges: 12,
recurringChargeAmount: 29.99,
chargeOnPlanSwitch: true,
});/recurring/plans POST
const getAllResponse = await bluesnap.plan.getAll({
pagesize: "5",
after: "2185254",
gettotal: true,
fulldescription: false,
});/recurring/plans?{parameters} GET
const getSpecificResponse = await bluesnap.plan.getSpecific({
planId: 2283845,
});BlueSnap identifier for the plan.
/recurring/plans/{planId} GET
const updateRecurringPlanResponse = await bluesnap.plan.updateRecurringPlan({
planId: 2111111,
chargeFrequency: "MONTHLY",
trialPeriodDays: "7",
initialChargeAmount: "30",
name: "Gold Plan",
currency: "USD",
recurringChargeAmount: "19",
});BlueSnap identifier for the plan.
/recurring/plans/{planId} PUT
const authTransactionResponse = await bluesnap.reversal.authTransaction({
cardTransactionType: "AUTH_REVERSAL",
transactionId: 1011671987,
});/transactions PUT
const createVaultedShopperResponse =
await bluesnap.shopper.createVaultedShopper({
firstName: "FirstName",
lastName: "LastName",
});paymentSources: ShopperCreateVaultedShopperRequestPaymentSources
/vaulted-shoppers POST
const deleteVaultedShopperResponse =
await bluesnap.shopper.deleteVaultedShopper({
vaultedShopperId: "20769005",
});vaultedShopperId received from BlueSnap
/vaulted-shoppers/{vaultedShopperId} DELETE
const getResponse = await bluesnap.shopper.get({
vaultedShopperId: "20769005",
});vaultedShopperId received from BlueSnap
/vaulted-shoppers/{vaultedShopperId} GET
const updateVaultedShopperResponse =
await bluesnap.shopper.updateVaultedShopper({
vaultedShopperId: "40444721",
firstName: "FirstName",
lastName: "LastName",
});vaultedShopperId received from BlueSnap
paymentSources: ShopperUpdateVaultedShopperRequestPaymentSources
/vaulted-shoppers/{vaultedShopperId} PUT
const createMerchantManagedChargeResponse =
await bluesnap.subscription.createMerchantManagedCharge({
subscriptionId: 10543419,
amount: 45,
currency: "USD",
merchantTransactionId: "MyUniqueOnDemandSubscription",
taxReference: "048deff0-a285-47e1-bc39-42f79bf0095b",
});BlueSnap identifier for the subscription.
/recurring/ondemand/{subscriptionId} POST
const createMerchantManagedSubscriptionResponse =
await bluesnap.subscription.createMerchantManagedSubscription({
amount: 45,
currency: "USD",
});/recurring/ondemand POST
const createNewResponse = await bluesnap.subscription.createNew({
planId: 2283845,
});payerInfo: SubscriptionCreateNewRequestPayerInfo
paymentSource: SubscriptionCreateNewRequestPaymentSource
/recurring/subscriptions POST
const getSpecificResponse = await bluesnap.subscription.getSpecific({
subscriptionId: 8491535,
});BlueSnap identifier for the subscription.
/recurring/subscriptions/{subscriptionId} GET
const getSwitchChargeAmountResponse =
await bluesnap.subscription.getSwitchChargeAmount({
newplanid: "111111",
newquantity: "2",
});/recurring/subscriptions/:subscriptionId/switch-charge-amount GET
const listAllSubscriptionsResponse =
await bluesnap.subscription.listAllSubscriptions({
pagesize: "5",
after: "34567",
gettotal: true,
fulldescription: false,
});/recurring/subscriptions?{parameters} GET
const listChargesResponse = await bluesnap.subscription.listCharges({
pagesize: "3",
after: "163193",
fulldescription: false,
});/:subscriptionId/charges?{parameters} GET
const updateSubscriptionResponse =
await bluesnap.subscription.updateSubscription({
subscriptionId: 8491543,
planId: "2283849",
});BlueSnap identifier for the subscription.
/recurring/subscriptions/{subscriptionId} PUT
const approveMerchantTransactionResponse =
await bluesnap.transaction.approveMerchantTransaction({
transactionid: "38612140",
approvetransaction: true,
});either transactionid or merchanttransactionid is required
ID of the transaction to be approved/declined
Set to true to approve the transaction or to false to decline the transaction. Default value is true.
/transactions/approval PUT
const cancelPendingRefundResponse =
await bluesnap.transaction.cancelPendingRefund({
transactionId: "1109144995",
});transactionId received from BlueSnap
/transactions/pending-refund/{transactionId} DELETE
const createBatchTransactionResponse =
await bluesnap.transaction.createBatchTransaction({});batchTransaction: TransactionCreateBatchTransactionRequestBatchTransaction
/batch-transactions POST
const createSofortTransactionResponse =
await bluesnap.transaction.createSofortTransaction({
amount: 42,
softDescriptor: "ABC COMPANY",
currency: "GBP",
authorizedByShopper: true,
});ecpTransaction: TransactionCreateSofortTransactionRequestEcpTransaction
becsDirectDebitTransaction: TransactionCreateSofortTransactionRequestBecsDirectDebitTransaction
idealTransaction: TransactionCreateSofortTransactionRequestIdealTransaction
localBankTransferTransaction: TransactionCreateSofortTransactionRequestLocalBankTransferTransaction
paypalTransaction: TransactionCreateSofortTransactionRequestPaypalTransaction
acssDirectDebitTransaction: TransactionCreateSofortTransactionRequestAcssDirectDebitTransaction
sepaDirectDebitTransaction: TransactionCreateSofortTransactionRequestSepaDirectDebitTransaction
sofortTransaction: TransactionCreateSofortTransactionRequestSofortTransaction
/alt-transactions POST
const getBatchTransactionResponse =
await bluesnap.transaction.getBatchTransaction({
batchId: "567890",
});batch ID sent in the Create Batch Transaction request
/batch-transactions/{batchId} GET
const getByIdResponse = await bluesnap.transaction.getById({
transactionId: "1011582369",
});transaction ID received in the response from BlueSnap
/transactions/{transactionId} GET
const getPaypalTransactionResponse =
await bluesnap.transaction.getPaypalTransaction({
orderId: "5666625",
});order ID received in the response
/alt-transactions/resolve?orderId={orderId} GET
for Australia and Canada
const getPreNotificationDebitAgreementResponse =
await bluesnap.transaction.getPreNotificationDebitAgreement({
transactionId: "38943468",
});Argument included in the response for the Create Debit Agreement request
/agreements/prenotification/{transactionId} GET
const getSepaDdResponse = await bluesnap.transaction.getSepaDd({
transactionId: "1014672453",
});transaction ID received in the response from BlueSnap
/alt-transactions/{transactionId} GET
const getSofortTransactionResponse =
await bluesnap.transaction.getSofortTransaction({
orderId: 20922493,
});Order ID received in the Create Sofort Transaction response from BlueSnap
/alt-transactions/resolve GET
const initiateRefundResponse = await bluesnap.transaction.initiateRefund({
transactionId: "1095710747",
reason: "Refund for order #1992",
cancelSubscriptions: false,
});ID of the transaction to be refunded
Required if not using merchantTransactionId
transactionMetaData: TransactionInitiateRefundRequestTransactionMetaData
/transactions/refund/{transactionId} POST
const updatePaypalTransactionResponse =
await bluesnap.transaction.updatePaypalTransaction({
amount: 105,
currency: "USD",
});paypalTransaction: TransactionUpdatePaypalTransactionRequestPaypalTransaction
/alt-transactions PUT
const createResponse = await bluesnap.vendor.create({
email: "vendor@example.com",
firstName: "Joe",
lastName: "Smith",
phone: "1-123-456-7890",
address: "123 Main Street",
city: "Boston",
country: "US",
state: "MA",
zip: "02453",
defaultPayoutCurrency: "USD",
ipnUrl: "https://ipnaddress.com",
});vendorPrincipal: VendorCreateRequestVendorPrincipal
vendorAgreement: VendorCreateRequestVendorAgreement
/vendors POST
const getAllVendorsResponse = await bluesnap.vendor.getAllVendors({
gettotal: true,
});/vendors?{parameters} GET
const getVendorResponse = await bluesnap.vendor.getVendor({
vendorId: 837389,
});BlueSnap identifier for the vendor
/vendors/{vendorId} GET
const updateVendorResponse = await bluesnap.vendor.updateVendor({
vendorId: 1,
email: "vendor@bluesnap.com",
name: "Important Vendor",
firstName: "Joe",
lastName: "Smith",
address: "123 Main Street",
city: "testing city",
zip: "02453",
country: "US",
phone: "1-054-976-6778",
state: "MA",
taxId: 123456789,
vendorUrl: "http://mycompany.com",
ipnUrl: "https://ipnaddress.com",
defaultPayoutCurrency: "USD",
});BlueSnap identifier for the vendor
vendorPrincipal: VendorUpdateVendorRequestVendorPrincipal
payoutInfo: VendorUpdateVendorRequestPayoutInfoInner[]
vendorAgreement: VendorUpdateVendorRequestVendorAgreement
/vendors/{vendorId} PUT
This TypeScript package is automatically generated by Konfig