BlueSnap integration guide
VerifiedHow to connect BlueSnap to WEXTL and use its 4 triggers and 49 actions in your workflows. About BlueSnap: Global payment gateway for accepting cards, local payment methods, and managing subscriptions.
- 4 triggers
- 20 searches
- 29 actions
- Polling
- Auth: API key
AI-assisted documentation36 min read
This documentation is compiled from our integration source code, internal specs for BlueSnap, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your BlueSnap credentials
- ConnectionselectRequired
- EnvironmentselectRequired
Connect BlueSnap in WEXTL
- Log in to your WEXTL account, add the BlueSnap node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your BlueSnap account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →

BlueSnap triggers and actions on WEXTL
The list below is a reference of every BlueSnap node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each BlueSnap node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch Plans
Trigger
| Field | Type |
|---|---|
| Name | text |
| Plan ID | number |
Watch Subscription Charges
Trigger
| Field | Type |
|---|---|
| Amount | number |
| Charge ID | number |
| Currency | text |
| Transaction date | date |
| Transaction region | text |
Watch Subscriptions
Trigger
| Field | Type |
|---|---|
| Vaulted shopper ID | number |
| Plan ID | number |
| Subscription ID | number |
Watch Vendors
Trigger
| Field | Type |
|---|---|
| Vendor ID | number |
| text | |
| Name | text |
| Vendor URL | text |
| First name | text |
| Last name | text |
| Address | text |
| City | text |
| Zip | text |
| Country | text |
| Phone | text |
| State | text |
| Vendor principal | object |
| First name | text |
| Last name | text |
| Address | text |
| City | text |
| Zip | text |
| Country | text |
| Dob | text |
| Personal identification number | text |
| Driver license number | text |
| text | |
| Payout configuration | object |
| Payout frequency | text |
| Review delay | number |
| Default legal entity | text |
| Regions | array |
| Vendor agreement | object |
| Commission percent | number |
| Account status | text |
| Recurring commission | text |
| Verification | object |
| Payout status | text |
| Processing status | text |
Get a Batch Transaction
Action
| Field | Type |
|---|---|
Batch IDRequired | text |
| Field | Type |
|---|---|
| Batch transaction | object |
| Batch ID | text |
| Callback URL | text |
| Transaction count | text |
| Card transaction | object |
| Alt transaction | array |
| Processing info | object |
| xmlns | text |
Get a BECS Direct Debit Transaction
Action
| Field | Type |
|---|---|
Transaction IDRequired | text |
| Field | Type |
|---|---|
| Merchant transaction ID | text |
| Transaction ID | text |
| Amount | number |
| Currency | text |
| Vaulted shopper ID | number |
| Payer info | object |
| First name | text |
| Last name | text |
| Country | text |
| Zip | text |
| Becs direct debit transaction | object |
| Bsb number | text |
| Account name | text |
| Financial institution | text |
| Branch name | text |
| Public account number | text |
| Agreement ID | number |
| Processing info | object |
| Processing status | text |
| Transaction region | text |
Get a Debit Agreement
Action
| Field | Type |
|---|---|
Agreement IDRequired | text |
| Field | Type |
|---|---|
| Region | text |
| Debit type | text |
| Agreement name | text |
| Agreement ID | number |
| Agreement text | text |
| Status | text |
Get a PayPal Transaction
Action
| Field | Type |
|---|---|
Order IDRequired | text |
| Field | Type |
|---|---|
| Transaction ID | number |
| Merchant transaction ID | number |
| Amount | number |
| Currency | text |
| Vaulted shopper ID | number |
| Soft descriptor | text |
| Transaction approval date | date |
| Transaction approval time | text |
| Payer info | object |
| First name | text |
| Last name | text |
| Paypal transaction | object |
| Paypal URL | text |
| Order ID | number |
| Processing info | object |
| Processing status | text |
| Transaction meta data | object |
| Meta data | array |
| Refunds | object |
| Refund | array |
Get a Plan
Action
| Field | Type |
|---|---|
Plan IDRequired | choice |
| Field | Type |
|---|---|
| Charge frequency | text |
| Grace period days | number |
| Trial period days | number |
| Initial charge amount | number |
| Name | text |
| Plan ID | number |
| Currency | text |
| Max number of charges | number |
| Recurring charge amount | number |
| Charge on plan switch | boolean |
| Status | text |
Get a Pre-Authorized Debit Transaction
Action
| Field | Type |
|---|---|
Transaction IDRequired | text |
| Field | Type |
|---|---|
| Merchant transaction ID | text |
| Transaction ID | text |
| Amount | number |
| Currency | text |
| Payer info | object |
| First name | text |
| Last name | text |
| Country | text |
| Zip | text |
| Vaulted shopper ID | number |
| Acss direct debit transaction | object |
| Routing number | text |
| Account type | text |
| Public account number | text |
| Agreement ID | number |
| Processing info | object |
| Processing status | text |
Get a Pre-Notification Debit Agreement
Action
| Field | Type |
|---|---|
Transaction IDRequired | text |
| Field | Type |
|---|---|
| Pre notification agreement text | text |
Get a SEPA DD Transaction
Action
| Field | Type |
|---|---|
Transaction IDRequired | text |
| Field | Type |
|---|---|
| Merchant transaction ID | text |
| Transaction ID | text |
| Soft descriptor | text |
| Amount | number |
| Currency | text |
| Transaction approval date | date |
| Transaction approval time | text |
| Payer info | object |
| First name | text |
| Last name | text |
| Vaulted shopper ID | number |
| Sepa direct debit transaction | object |
| Iban first four | text |
| Iban last four | text |
| Mandate ID | text |
| Mandate date | text |
| Processing info | object |
| Processing status | text |
Get a Specific Charge
Action
| Field | Type |
|---|---|
Transaction IDRequired | text |
| Field | Type |
|---|---|
| Amount | number |
| Vaulted shopper ID | number |
| Charge info | object |
| From date | date |
| To date | date |
| Charge type | text |
| Processing info | object |
| Processing status | text |
| Cvv response code | text |
| Authorization code | text |
| Avs response code zip | text |
| Avs response code address | text |
| Avs response code name | text |
| Network transaction ID | number |
| Transaction region | text |
| Charge ID | number |
| Payment source | object |
| Credit card info | object |
| Soft descriptor | text |
| Plan ID | number |
| Currency | text |
| Transaction date | date |
| Subscription ID | number |
| Transaction ID | number |
Get a Subscription
Action
| Field | Type |
|---|---|
Subscription IDRequired | choice |
| Field | Type |
|---|---|
| Next charge date | text |
| Quantity | number |
| Trial period days | number |
| Payment source | object |
| Credit card info | object |
| Soft descriptor | text |
| Recurring charge amount | number |
| Charge frequency | text |
| Vaulted shopper ID | number |
| Payer info | object |
| First name | text |
| Last name | text |
| Initial charge amount | number |
| Auto renew | boolean |
| Plan ID | number |
| Currency | text |
| Subscription ID | number |
| Status | text |
Get a Vaulted Shopper
Action
| Field | Type |
|---|---|
Vaulted Shopper IDRequired | text |
| Field | Type |
|---|---|
| Vaulted shopper ID | number |
| Merchant shopper ID | text |
| First name | text |
| Last name | text |
| Country | text |
| Zip | text |
| Phone | text |
| Shopper currency | text |
| Date created | date |
| Time created | text |
| Payment sources | object |
| Credit card info | array |
| Ecp details | array |
| Last payment info | object |
| Payment method | text |
| Credit card | object |
Get a Vendor
Action
| Field | Type |
|---|---|
Vendor IDRequired | choice |
| Field | Type |
|---|---|
| Vendor ID | number |
| text | |
| Name | text |
| First name | text |
| Last name | text |
| Address | text |
| City | text |
| Zip | text |
| Country | text |
| Phone | text |
| State | text |
| Vendor principal | object |
| First name | text |
| Last name | text |
| Address | text |
| City | text |
| Zip | text |
| Country | text |
| Dob | text |
| Personal identification number | text |
| Driver license number | text |
| text | |
| Payout configuration | object |
| Payout frequency | text |
| Review delay | number |
| Default legal entity | text |
| Regions | array |
| Vendor agreement | object |
| Commission percent | number |
| Account status | text |
| Recurring commission | text |
| Verification | object |
| Payout status | text |
| Processing status | text |
Get a Wallet
Action
| Field | Type |
|---|---|
Wallet IDRequired | choice |
| Field | Type |
|---|---|
| Country | text |
| First name | text |
| Last name | text |
| Billing contact info | object |
| Zip | text |
| Country | text |
| Address 2 | text |
| City | text |
| Address 1 | text |
| State | text |
| Phone | text |
| Shipping contact info | object |
| Zip | text |
| Country | text |
| First name | text |
| Last name | text |
| Address 2 | text |
| City | text |
| Phone | text |
| Address 1 | text |
| State | text |
| Credit card | object |
| Expiration year | number |
| Card last four digits | text |
| Card fingerprint | text |
| Card sub type | text |
| Card type | text |
| Card category | text |
| Expiration month | number |
| text |
Get an ECP Transaction
Action
| Field | Type |
|---|---|
Transaction IDRequired | text |
| Field | Type |
|---|---|
| Transaction ID | text |
| Merchant transaction ID | text |
| Amount | number |
| Currency | text |
| Soft descriptor | text |
| Vaulted shopper ID | number |
| Payer info | object |
| First name | text |
| Last name | text |
| Zip | text |
| Phone | text |
| Ecp transaction | object |
| Routing number | text |
| Account type | text |
| Account number | number |
| Public account number | text |
| Public routing number | text |
| Processing info | object |
| Processing status | text |
| Transaction region | text |
| Fraud result info | object |
| Device data collector | text |
Get Subscription Switch Charge Amount
Action
| Field | Type |
|---|---|
Subscription IDRequired | choice |
New Plan IDRequired | choice |
| New Quantity | number |
| Override Amount | number |
| Field | Type |
|---|---|
| Currency | text |
| Value | number |
List Plans
Search
| Field | Type |
|---|---|
| Full Description | boolean |
| Status | choice |
| Limit | number |
| Field | Type |
|---|---|
| Name | text |
| Plan ID | number |
List Subscription Charges
Search
| Field | Type |
|---|---|
| Charge ID | choice |
| Full Description | boolean |
| Status | choice |
| Limit | number |
| Field | Type |
|---|---|
| Amount | number |
| Charge ID | number |
| Currency | text |
| Transaction date | text |
| Transaction region | text |
List Subscriptions
Search
| Field | Type |
|---|---|
| Full Description | boolean |
| Status | choice |
| Limit | number |
| Field | Type |
|---|---|
| Vaulted shopper ID | number |
| Plan ID | number |
| Subscription ID | number |
List Vendors
Search
| Field | Type |
|---|---|
| Limit | number |
| Field | Type |
|---|---|
| Vendor ID | number |
| text | |
| Name | text |
| Vendor URL | text |
| First name | text |
| Last name | text |
| Address | text |
| City | text |
| Zip | text |
| Country | text |
| Phone | text |
| State | text |
| Vendor principal | object |
| First name | text |
| Last name | text |
| Address | text |
| City | text |
| Zip | text |
| Country | text |
| Dob | text |
| Personal identification number | text |
| Driver license number | text |
| text | |
| Payout configuration | object |
| Payout frequency | text |
| Review delay | number |
| Default legal entity | text |
| Regions | array |
| Vendor agreement | object |
| Commission percent | number |
| Account status | text |
| Recurring commission | text |
| Verification | object |
| Payout status | text |
| Processing status | text |
Retrieve a Transaction
Action
| Field | Type |
|---|---|
Transaction IDRequired | text |
Authorize a Transaction
Action
| Field | Type |
|---|---|
AmountRequired | number |
Soft DescriptorRequired | text |
CurrencyRequired | text |
Card Transaction TypeRequired | choice |
Card Holder InfoRequired | object |
First NameRequired | text |
Last NameRequired | text |
Zip CodeRequired | text |
| Transaction Fraud Info | object |
Shopper IP AddressRequired | text |
| Fraud Session ID | text |
| Customer ID | text |
| Customer Creation Date | date |
| Company | text |
| Shipping Contact Info | object |
Credit CardRequired | object |
Expiration YearRequired | text |
Expiration MonthRequired | text |
Security CodeRequired | text |
Card NumberRequired | text |
| Field | Type |
|---|---|
| Card transaction type | text |
| Transaction ID | text |
| Merchant transaction ID | text |
| Soft descriptor | text |
| Amount | number |
| Usd amount | number |
| Currency | text |
| Vaulted shopper ID | number |
| Avs response code | text |
| Card holder info | object |
| First name | text |
| Last name | text |
| Zip | text |
| Country | text |
| Credit card | object |
| Card last four digits | text |
| Card type | text |
| Card sub type | text |
| Card category | text |
| Bin category | text |
| Card regulated | text |
| Issuing bank | text |
| Issuing country code | text |
| Processing info | object |
| Processing status | text |
| Cvv response code | text |
| Authorization code | text |
| Avs response code zip | text |
| Avs response code address | text |
| Avs response code name | text |
| Transaction region | text |
| Supports multi partial capture | boolean |
| Fraud result info | object |
| Device data collector | text |
| Vendor info | object |
| Vendor ID | number |
| Commission percent | number |
| Vendors info | object |
| Vendor info | array |
| Transaction meta data | object |
| Meta data | array |
| Wallet | object |
| Wallet type | text |
| Billing contact info | object |
| Tokenized card | object |
Calculate a Prorated Surcharge
Action
| Field | Type |
|---|---|
AmountRequired | number |
| Surcharge Information | object |
Surcharge TokenRequired | text |
| Field | Type |
|---|---|
| Amount | text |
| Currency | text |
| Surcharge info | object |
| Surcharge reference | number |
| Surcharge amount | number |
| Surcharge rate | number |
| Description | text |
| Surcharge token | text |
Calculate Surcharge
Action
| Field | Type |
|---|---|
CurrencyRequired | text |
AmountRequired | text |
Payment MethodRequired | text |
| Payment Field Token | text |
| Wallet | object |
| Vaulted Shopper ID | number |
| Credit Card | object |
| Field | Type |
|---|---|
| Amount | text |
| Currency | text |
| Payer details | object |
| First name | text |
| Last name | text |
| text | |
| Country | text |
| State | text |
| Personal identification number | text |
| Payment method | text |
| Credit card | object |
| Card last four digits | text |
| Card type | text |
| Card sub type | text |
| Bin category | text |
| Surcharge info | object |
| Surcharge reference | number |
| Surcharge amount | number |
| Surcharge rate | number |
| Description | text |
| Surcharge token | text |
Cancel a Pending Refund
Action
| Field | Type |
|---|---|
Transaction IDRequired | text |
Capture an Auth
Action
| Field | Type |
|---|---|
AmountRequired | number |
Card Transaction TypeRequired | choice |
CurrencyRequired | text |
| Card Holder Info | object |
EmailRequired | |
Personal Identification NumberRequired | text |
| Address | text |
| Address 2 | text |
| City | text |
| Company Name | text |
| Country | text |
| First Name | text |
| Last Name | text |
| Merchant Shopper ID | text |
| Credit Card | object |
Expiration MonthRequired | text |
Expiration YearRequired | text |
Card NumberRequired | text |
Encrypted Card NumberRequired | text |
| Card Last Four Digits | text |
| Card Type | choice |
| Security Code | text |
| Encrypted Security Code | text |
| Security Code PF Token | text |
| Descriptor Phone Number | text |
| Level 3 Data | object |
| Customer Reference Number | text |
| Destination Country Code | text |
| Destination Zip Code | text |
| Discount Amount | number |
| Duty Amount | number |
| Freight Amount | number |
| Level 3 Data Items | array |
| Sales Tax Amount | number |
| Ship From Zip Code | text |
| Tax Amount | number |
| Merchant Transaction ID | text |
| Metadata | object |
| Network Transaction Info | object |
| Original Network Transaction ID | text |
| PF Token | text |
| Product Description | text |
| Soft Descriptor | text |
| Store Card | boolean |
| Surcharge Info | object |
Surcharge TokenRequired | text |
| Surcharge Reference | number |
| Surcharge Amount | number |
| Tax Reference | text |
| Three D Secure | object |
| ACS Transaction ID | text |
| CAVV | text |
| CAVV Algorithm | text |
| Challenge Required | boolean |
| DS Transaction ID | text |
| ECI | text |
| Enrollment Status | text |
| Network Score | text |
| Reason Code | text |
| 3D Secure Reference ID | text |
| Transaction Fraud Info | object |
| Transaction Initiator | choice |
| Transaction Meta Data | object |
6other input fields
| Field | Type |
|---|---|
| Card transaction type | text |
| Transaction ID | text |
| Merchant transaction ID | text |
| Soft descriptor | text |
| Amount | number |
| Usd amount | number |
| Currency | text |
| Transaction approval date | date |
| Transaction approval time | text |
| Vendor info | object |
| Vendor ID | number |
| Commission percent | number |
| Vendors info | object |
| Vendor info | array |
| Card holder info | object |
| First name | text |
| Last name | text |
| Merchant shopper ID | text |
| Country | text |
| State | text |
| Zip | text |
| text | |
| Payer details | object |
| First name | text |
| Last name | text |
| text | |
| Country | text |
| State | text |
| Vaulted shopper ID | number |
| Credit card | object |
| Card last four digits | text |
| Card type | text |
| Card sub type | text |
| Card category | text |
| Bin category | text |
| Card regulated | text |
| Issuing bank | text |
| Issuing country code | text |
| Expiration month | text |
| Expiration year | text |
| Surcharge info | object |
| Surcharge reference | number |
| Surcharge amount | number |
| Surcharge rate | number |
| Description | text |
| Surcharge token | text |
| Transaction meta data | object |
| Meta data | array |
| Processing info | object |
| Processing status | text |
| Cvv response code | text |
| Authorization code | text |
| Avs response code zip | text |
| Avs response code address | text |
| Avs response code name | text |
| Transaction region | text |
| Fraud result info | object |
| Device data collector | text |
| Avs response code | text |
2other output fields
Create a Batch Transaction
Action
| Field | Type |
|---|---|
Batch IDRequired | text |
Callback URLRequired | url |
Batch TransactionRequired | object |
Alternative TransactionRequired | object |
Card TransactionRequired | object |
Create a BECS Direct Debit Transaction
Action
| Field | Type |
|---|---|
AmountRequired | number |
CurrencyRequired | text |
Authorized by ShopperRequired | boolean |
| BECS Direct Debit Transaction | object |
BSB NumberRequired | text |
Account NumberRequired | text |
Account NameRequired | text |
| Financial Institution | text |
| Branch Name | text |
| Agreement ID | number |
| Payer Info | object |
First NameRequired | text |
Last NameRequired | text |
| ZIP Code | text |
| Country | text |
| Transaction MetaData | object |
| Metadata | array |
Vaulted Shopper IDRequired | number |
| Vendors Info | object |
Vendor IDRequired | number |
| Commission Amount | number |
| Commission Percent | number |
| Recurring Commission Amount | number |
| Recurring Commission Percent | number |
| Field | Type |
|---|---|
| Transaction ID | text |
| Amount | number |
| Currency | text |
| Vaulted shopper ID | number |
| Payer info | object |
| First name | text |
| Last name | text |
| Country | text |
| Zip | text |
| Becs direct debit transaction | object |
| Bsb number | text |
| Account name | text |
| Financial institution | text |
| Branch name | text |
| Public account number | text |
| Agreement ID | number |
| Pre notification ref | text |
| Processing info | object |
| Processing status | text |
| Transaction region | text |
Create a Capture
Action
| Field | Type |
|---|---|
AmountRequired | number |
Card Transaction TypeRequired | choice |
CurrencyRequired | text |
| Card Holder Info | object |
EmailRequired | |
Personal Identification NumberRequired | text |
| Address | text |
| Address 2 | text |
| City | text |
| Company Name | text |
| Country | text |
| First Name | text |
| Last Name | text |
| Merchant Shopper ID | text |
| Credit Card | object |
Expiration MonthRequired | text |
Expiration YearRequired | text |
Card NumberRequired | text |
Encrypted Card NumberRequired | text |
| Card Last Four Digits | text |
| Card Type | choice |
| Security Code | text |
| Encrypted Security Code | text |
| Security Code PF Token | text |
| Descriptor Phone Number | text |
| Level 3 Data | object |
| Customer Reference Number | text |
| Destination Country Code | text |
| Destination Zip Code | text |
| Discount Amount | number |
| Duty Amount | number |
| Freight Amount | number |
| Level 3 Data Items | array |
| Sales Tax Amount | number |
| Ship From Zip Code | text |
| Tax Amount | number |
| Merchant Transaction ID | text |
| Metadata | object |
| Network Transaction Info | object |
| Original Network Transaction ID | text |
| PF Token | text |
| Product Description | text |
| Soft Descriptor | text |
| Store Card | boolean |
| Surcharge Info | object |
Surcharge TokenRequired | text |
| Surcharge Reference | number |
| Surcharge Amount | number |
| Tax Reference | text |
| Three D Secure | object |
| ACS Transaction ID | text |
| CAVV | text |
| CAVV Algorithm | text |
| Challenge Required | boolean |
| DS Transaction ID | text |
| ECI | text |
| Enrollment Status | text |
| Network Score | text |
| Reason Code | text |
| 3D Secure Reference ID | text |
| Transaction Fraud Info | object |
| Transaction Initiator | choice |
| Transaction Meta Data | object |
6other input fields
| Field | Type |
|---|---|
| Card transaction type | text |
| Transaction ID | text |
| Soft descriptor | text |
| Amount | number |
| Usd amount | number |
| Open to capture | number |
| Currency | text |
| Transaction approval date | date |
| Transaction approval time | text |
| Vaulted shopper ID | number |
| Recurring transaction | text |
| Product description | text |
| Vendor info | object |
| Vendor ID | number |
| Commission percent | number |
| Vendors info | object |
| Vendors info processing status | text |
| Vendor info | array |
| Card holder info | object |
| First name | text |
| Last name | text |
| Country | text |
| State | text |
| Address | text |
| City | text |
| Zip | text |
| Phone | text |
| Credit card | object |
| Card last four digits | text |
| Card type | text |
| Card sub type | text |
| Card category | text |
| Bin category | text |
| Bin number | text |
| Card regulated | text |
| Issuing bank | text |
| Expiration month | text |
| Expiration year | text |
| Network transaction info | object |
| Original network transaction ID | text |
| Network transaction ID | text |
| Surcharge info | object |
| Surcharge reference | number |
| Surcharge amount | number |
| Surcharge rate | number |
| Description | text |
| Processing info | object |
| Processing status | text |
| Cvv response code | text |
| Authorization code | text |
| Avs response code zip | text |
| Avs response code address | text |
| Avs response code name | text |
| Network transaction ID | text |
| Transaction region | text |
| Supports multi partial capture | boolean |
| Fraud result info | object |
| Device data collector | text |
Create a Merchant-Managed Subscription
Action
| Field | Type |
|---|---|
AmountRequired | number |
Authorized By ShopperRequired | boolean |
CurrencyRequired | text |
| Descriptor Phone Number | text |
| Level 3 Data | object |
| Merchant Transaction ID | text |
| Network Transaction Info | object |
| Soft Descriptor | text |
| Tax Reference | text |
| Three D Secure | object |
| ACS Transaction ID | text |
| CAVV | text |
| CAVV Algorithm | text |
| Challenge Required | boolean |
| DS Transaction ID | text |
| ECI | text |
| Enrollment Status | text |
| Network Score | text |
| Reason Code | text |
| 3D Secure Reference ID | text |
| Payer Info | object |
First NameRequired | text |
Last NameRequired | text |
Zip CodeRequired | text |
CountryRequired | text |
| Payment Source | object |
| Credit Card Info | object |
| Transaction Fraud Info | object |
| Scheduled | boolean |
| Transaction Initiator | text |
| Transaction MetaData | object |
| Vaulted Shopper ID | number |
| Vendors Info | object |
Create a Merchant-Managed Subscription Charge
Action
| Field | Type |
|---|---|
Subscription IDRequired | choice |
AmountRequired | number |
CurrencyRequired | text |
Merchant Transaction IDRequired | text |
| Tax Reference | text |
| Transaction MetaData | object |
| MetaData | array |
| Field | Type |
|---|---|
| Charge ID | number |
| Subscription ID | number |
| Vaulted shopper ID | number |
| Transaction ID | text |
| Merchant transaction ID | text |
| Tax reference | text |
| Transaction date | date |
| Amount | number |
| Currency | text |
| Soft descriptor | text |
| Payment source | object |
| Credit card info | object |
| Charge info | object |
| Charge description | text |
| Charge type | text |
| Processing info | object |
| Processing status | text |
| Cvv response code | text |
| Authorization code | text |
| Avs response code zip | text |
| Avs response code address | text |
| Avs response code name | text |
| Network transaction ID | number |
| Transaction region | text |
Create a PayPal Transaction
Action
| Field | Type |
|---|---|
AmountRequired | number |
CurrencyRequired | text |
PayPal TransactionRequired | object |
Cancel URLRequired | url |
Return URLRequired | url |
Transaction TypeRequired | choice |
| In-Context Checkout | boolean |
| No Shipping | choice |
| PayPal Subscription ID | text |
| Recurring | text |
| Require Confirm Shipping | choice |
| Merchant Transaction ID | text |
| Payer Info | object |
First NameRequired | text |
Last NameRequired | text |
| Country | text |
| Personal Identification Number | text |
| Address | text |
| Address Line 2 | text |
| City | text |
| Company Name | text |
| Merchant Shopper ID | text |
| Product Description | text |
| Soft Descriptor | text |
| Tax Reference | text |
| Transaction Description | text |
| Transaction MetaData | object |
| Meta Data | array |
| Vaulted Shopper ID | number |
| Field | Type |
|---|---|
| Transaction ID | number |
| Merchant transaction ID | number |
| Amount | number |
| Currency | text |
| Vaulted shopper ID | number |
| Soft descriptor | text |
| Transaction approval date | text |
| Transaction approval time | text |
| Tax reference | text |
| Payer info | object |
| First name | text |
| Last name | text |
| Paypal transaction | object |
| Paypal URL | text |
| Order ID | number |
| Paypal subscription ID | number |
| Processing info | object |
| Processing status | text |
| Transaction meta data | object |
| Meta data | array |
Create a Plan
Action
| Field | Type |
|---|---|
Charge FrequencyRequired | text |
CurrencyRequired | text |
NameRequired | text |
Recurring Charge AmountRequired | number |
| Charge On Plan Switch | boolean |
| Grace Period Days | number |
| Initial Charge Amount | number |
| Max Number Of Charges | number |
| Trial Period Days | number |
| Field | Type |
|---|---|
| Charge frequency | text |
| Grace period days | number |
| Trial period days | number |
| Initial charge amount | number |
| Name | text |
| Plan ID | number |
| Currency | text |
| Max number of charges | number |
| Recurring charge amount | number |
| Charge on plan switch | boolean |
| Status | text |
Create a Pre-Authorized Debit Transaction
Action
| Field | Type |
|---|---|
ACSS Direct Debit TransactionRequired | object |
Account NumberRequired | text |
Account TypeRequired | choice |
Agreement IDRequired | number |
Routing NumberRequired | text |
AmountRequired | number |
CurrencyRequired | text |
Authorized by ShopperRequired | boolean |
| BECS Direct Debit Transaction | object |
BSB NumberRequired | text |
Account NumberRequired | text |
Account NameRequired | text |
| Financial Institution | text |
| Branch Name | text |
| Agreement ID | number |
| Payer Info | object |
First NameRequired | text |
Last NameRequired | text |
| ZIP Code | text |
| Country | text |
| Transaction MetaData | object |
| Metadata | array |
Vaulted Shopper IDRequired | number |
| Vendors Info | object |
Vendor IDRequired | number |
| Commission Amount | number |
| Commission Percent | number |
| Recurring Commission Amount | number |
| Recurring Commission Percent | number |
| Field | Type |
|---|---|
| Transaction ID | text |
| Amount | number |
| Currency | text |
| Payer info | object |
| First name | text |
| Last name | text |
| Country | text |
| Zip | text |
| Vaulted shopper ID | number |
| Acss direct debit transaction | object |
| Routing number | text |
| Account type | text |
| Public account number | text |
| Agreement ID | number |
| Processing info | object |
| Processing status | text |
| Transaction region | text |
Create a SEPA DD Transaction
Action
| Field | Type |
|---|---|
AmountRequired | number |
Authorized by ShopperRequired | boolean |
CurrencyRequired | text |
| Payer Info | object |
First NameRequired | text |
Last NameRequired | text |
| ZIP Code | text |
| Country | text |
SEPA Direct Debit TransactionRequired | object |
| Vaulted Shopper ID | number |
| Vendors Info | object |
Vendor IDRequired | number |
| Commission Amount | number |
| Commission Percent | number |
| Recurring Commission Amount | number |
| Recurring Commission Percent | number |
| Country | text |
| Merchant Transaction ID | text |
| Product Description | text |
| Soft Descriptor | text |
| Tax Reference | text |
| Transaction Fraud Info | object |
| Customer Creation Date | date |
| Customer ID | text |
| Fraud Session ID | text |
| Shopper IP Address | text |
| Company | text |
| Enterprise Site ID | text |
| Enterprise UDFs | object |
| Fraud Products | array |
| Shipping Contact Info | object |
| Transaction MetaData | object |
| Metadata | array |
| Field | Type |
|---|---|
| Transaction ID | text |
| Soft descriptor | text |
| Amount | number |
| Currency | text |
| Vaulted shopper ID | number |
| Tax reference | text |
| Payer info | object |
| First name | text |
| Last name | text |
| Sepa direct debit transaction | object |
| Iban first four | text |
| Iban last four | text |
| Mandate ID | text |
| Mandate date | text |
| Pre notification text | text |
| Pre notification translation ref | text |
| Processing info | object |
| Processing status | text |
| Transaction region | text |
Create a Subscription
Action
| Field | Type |
|---|---|
Plan IDRequired | choice |
Authorized By ShopperRequired | boolean |
| Payment Source | object |
| Descriptor Phone Number | text |
| Initial Tax Reference | text |
| Level 3 Data | object |
| Network Transaction Info | object |
| Override Initial Charge Amount | number |
| Override Recurring Charge Amount | number |
| Override Trial Period Days | number |
| Payer Info | object |
First NameRequired | text |
Last NameRequired | text |
| ZIP Code | text |
| Country | text |
| Quantity | number |
| Recurring Tax Reference | text |
| Soft Descriptor | text |
| Three D Secure | object |
| ACS Transaction ID | text |
| CAVV | text |
| CAVV Algorithm | text |
| Challenge Required | boolean |
| DS Transaction ID | text |
| ECI | text |
| Enrollment Status | text |
| Network Score | text |
| Reason Code | text |
| 3D Secure Reference ID | text |
| Transaction Fraud Info | object |
| Transaction Initiator | text |
| Vaulted Shopper ID | number |
| Vendors Info | object |
Create a Vaulted Shopper
Action
| Field | Type |
|---|---|
Company NameRequired | text |
PF TokenRequired | text |
| Address | text |
| Address 2 | text |
| City | text |
| Country | text |
| Descriptor Phone Number | text |
| First Name | text |
| Last Name | text |
| Merchant Shopper ID | text |
| Payment Sources | object |
| Phone | text |
| Shipping Contact Info | object |
| Credit Card Info | array |
| Pay By Bank Info | array |
| ACSS Direct Debit Info | array |
| BECS Direct Debit Info | array |
| ECP Details | array |
| ECP Info | object |
| SEPA Direct Debit Info | array |
| Shopper Currency | text |
| Soft Descriptor | text |
| State | text |
| Three D Secure | object |
| ACS Transaction ID | text |
| CAVV | text |
| CAVV Algorithm | choice |
| Challenge Required | boolean |
| DS Transaction ID | text |
| ECI | text |
| Enrollment Status | choice |
| Network Score | text |
| Reason Code | text |
| 3DS Secure Reference ID | text |
| Transaction Fraud Info | object |
| Customer Creation Date | date |
| Company | text |
| Customer ID | text |
| Enterprise Site ID | text |
| Enterprise UDFs | object |
| Fraud Products | array |
| Fraud Session ID | text |
| Shopper IP Address | text |
| Shipping Contact Info | object |
| Transaction Order Source | text |
2other input fields
| Field | Type |
|---|---|
| Vaulted shopper ID | number |
| First name | text |
| Last name | text |
| Merchant shopper ID | text |
| Country | text |
| Zip | text |
| Phone | text |
| Soft descriptor | text |
| Shopper currency | text |
| Payment sources | object |
| Credit card info | array |
| Fraud result info | object |
| Device data collector | text |
| Date created | date |
| Time created | text |
Create a Vendor
Action
| Field | Type |
|---|---|
EmailRequired | |
First NameRequired | text |
Last NameRequired | text |
| Phone | text |
| Address | text |
| City | text |
| Country | text |
| State | text |
| Zip | text |
| Vendor Principal | object |
| First Name | text |
| Last Name | text |
| Address | text |
| City | text |
| Country | text |
| Zip | text |
| Date of Birth | text |
| Personal Identification Number | text |
| Driver License Number | text |
| Vendor Agreement | object |
| Commission Percent | number |
| Payout Configuration | object |
| Review Delay | number |
| Payout Frequency | text |
| Default Legal Entity | text |
| Regions | array |
Create a Wallet
Action
| Field | Type |
|---|---|
Wallet TypeRequired | text |
Validation URLRequired | url |
Domain NameRequired | text |
| Display Name | text |
| Field | Type |
|---|---|
| Wallet type | text |
| Wallet token | text |
Create an Auth Reversal
Action
| Field | Type |
|---|---|
Card Transaction TypeRequired | choice |
| Merchant Transaction ID | text |
| Transaction ID | text |
| Field | Type |
|---|---|
| Card transaction type | text |
| Transaction ID | number |
| Merchant transaction ID | number |
| Amount | number |
| Currency | text |
| Vaulted shopper ID | number |
| Soft descriptor | text |
| Card holder info | object |
| First name | text |
| Last name | text |
| Zip | text |
| Credit card | object |
| Card last four digits | text |
| Card sub type | text |
| Card type | text |
| Card category | text |
| Processing info | object |
| Processing status | text |
| Cvv response code | text |
| Avs response code zip | text |
| Avs response code address | text |
| Avs response code name | text |
Create an ECP Transaction
Action
| Field | Type |
|---|---|
| ECP Transaction | object |
Routing NumberRequired | text |
Account NumberRequired | number |
Account TypeRequired | choice |
Routing NumberRequired | number |
Account NumberRequired | text |
AmountRequired | text |
CurrencyRequired | text |
Authorized By ShopperRequired | boolean |
| Payer Info | object |
First NameRequired | text |
Last NameRequired | text |
ZIPRequired | text |
| Phone | text |
| Soft Descriptor | text |
| Transaction Fraud Info | object |
| Fraud Session ID | text |
| Customer ID | text |
| Customer Creation Date | date |
Vaulted Shopper IDRequired | number |
| Transaction MetaData | object |
| Metadata | array |
| Vendors Info | object |
Vendor IDRequired | number |
| Commission Amount | number |
| Commission Percent | number |
| Recurring Commission Amount | number |
| Recurring Commission Percent | number |
| Field | Type |
|---|---|
| Transaction ID | text |
| Merchant transaction ID | text |
| Amount | number |
| Currency | text |
| Soft descriptor | text |
| Vaulted shopper ID | number |
| Payer info | object |
| First name | text |
| Last name | text |
| Zip | text |
| Phone | text |
| Ecp transaction | object |
| Routing number | text |
| Account type | text |
| Account number | number |
| Public account number | text |
| Public routing number | text |
| Processing info | object |
| Processing status | text |
| Transaction region | text |
| Fraud result info | object |
| Device data collector | text |
Create Debit Agreement
Action
| Field | Type |
|---|---|
RegionRequired | choice |
TypeRequired | choice |
| Language | choice |
| Override Recurring Charge Amount | number |
| Plain ID | number |
| Field | Type |
|---|---|
| Region | text |
| Debit type | text |
| Agreement name | text |
| Agreement ID | number |
| Agreement text | text |
| Status | text |
Delete a Vaulted Shopper
Action
| Field | Type |
|---|---|
Vaulted Shopper IDRequired | text |
Make an API Call
universal
| Field | Type |
|---|---|
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query String | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Status code | number |
Refund a Transaction
Action
| Field | Type |
|---|---|
Transaction IDRequired | text |
| Reason | text |
| Cancel Subscriptions | boolean |
| Transaction Metadata | object |
| Metadata | array |
| Simulate No Funds | boolean |
| Field | Type |
|---|---|
| Refund transaction ID | number |
| Transaction meta data | object |
| Meta data | array |
| Reason | text |
| Cancel subscriptions | boolean |
Update a PayPal Transaction
Action
| Field | Type |
|---|---|
AmountRequired | number |
CurrencyRequired | text |
PayPal TransactionRequired | object |
Cancel URLRequired | url |
Return URLRequired | url |
Transaction TypeRequired | choice |
| In-Context Checkout | boolean |
| No Shipping | choice |
| PayPal Subscription ID | text |
| Recurring | text |
| Require Confirm Shipping | choice |
| Merchant Transaction ID | text |
| Payer Info | object |
First NameRequired | text |
Last NameRequired | text |
| Country | text |
| Personal Identification Number | text |
| Address | text |
| Address Line 2 | text |
| City | text |
| Company Name | text |
| Merchant Shopper ID | text |
| Product Description | text |
| Soft Descriptor | text |
| Tax Reference | text |
| Transaction Description | text |
| Transaction MetaData | object |
| Meta Data | array |
| Vaulted Shopper ID | number |
| Field | Type |
|---|---|
| Merchant transaction ID | text |
| Transaction ID | text |
| Amount | number |
| Currency | text |
| Transaction approval date | date |
| Transaction approval time | text |
| Vaulted shopper ID | text |
| Paypal transaction | object |
| Order ID | text |
| Processing info | object |
| Processing status | text |
Update a Plan
Action
| Field | Type |
|---|---|
Plan IDRequired | choice |
Charge FrequencyRequired | text |
CurrencyRequired | text |
NameRequired | text |
Recurring Charge AmountRequired | number |
| Charge On Plan Switch | boolean |
| Grace Period Days | number |
| Initial Charge Amount | number |
| Max Number Of Charges | number |
| Trial Period Days | number |
| Field | Type |
|---|---|
| Charge frequency | text |
| Grace period days | number |
| Trial period days | number |
| Initial charge amount | number |
| Name | text |
| Plan ID | number |
| Currency | text |
| Max number of charges | number |
| Recurring charge amount | number |
| Charge on plan switch | boolean |
| Status | text |
Update a Subscription
Action
| Field | Type |
|---|---|
Subscription IDRequired | choice |
| Plan ID | choice |
| Quantity | number |
| Auto Renew | boolean |
| Next Charge Date | text |
| Override Recurring Charge Amount | number |
| Payment Source | object |
Credit Card InfoRequired | object |
ECP InfoRequired | object |
SEPA Direct Debit InfoRequired | object |
WalletRequired | object |
| ACSS Direct Debit Info | array |
| BECS Direct Debit Info | array |
| Vendors Info | object |
Vendor IDRequired | choice |
| Commission Amount | number |
| Commission Percent | number |
| Recurring Commission Amount | number |
| Recurring Commission Percent | number |
| Field | Type |
|---|---|
| Next charge date | text |
| Quantity | number |
| Trial period days | number |
| Payment source | object |
| Credit card info | object |
| Soft descriptor | text |
| Recurring charge amount | number |
| Charge frequency | text |
| Vaulted shopper ID | number |
| Payer info | object |
| First name | text |
| Last name | text |
| Initial charge amount | number |
| Auto renew | boolean |
| Plan ID | number |
| Currency | text |
| Subscription ID | number |
| Status | text |
Update a Vaulted Shopper
Action
| Field | Type |
|---|---|
Vaulted Shopper IDRequired | text |
Company NameRequired | text |
PF TokenRequired | text |
| Address | text |
Chosen Payment Method TypeRequired | choice |
| Credit Card | object |
Expiration MonthRequired | text |
Expiration YearRequired | text |
| Card Number | text |
| Encrypted Card Number | text |
| Card Last Four Digits | text |
| Card Type | choice |
| Encrypted Security Code | text |
| Security Code | text |
| Security Code PF Token | text |
| Address 2 | text |
| City | text |
| Country | text |
| Descriptor Phone Number | text |
| First Name | text |
| Last Name | text |
| Merchant Shopper ID | text |
| Payment Sources | object |
| Phone | text |
| Shipping Contact Info | object |
| Credit Card Info | array |
| Pay By Bank Info | array |
| ACSS Direct Debit Info | array |
| BECS Direct Debit Info | array |
| ECP Details | array |
| ECP Info | object |
| SEPA Direct Debit Info | array |
| Shopper Currency | text |
| Soft Descriptor | text |
| State | text |
5other input fields
| Field | Type |
|---|---|
| Vaulted shopper ID | number |
| First name | text |
| Last name | text |
| Country | text |
| Zip | text |
| Phone | text |
| Shopper currency | text |
| Payment sources | object |
| Ecp details | array |
| Fraud result info | object |
| Device data collector | text |
| Date created | date |
| Time created | text |
Update a Vendor
Action
| Field | Type |
|---|---|
Vendor IDRequired | choice |
EmailRequired | |
NameRequired | text |
| First Name | text |
| Last Name | text |
| Address | text |
| City | text |
| ZIP | text |
| Country | text |
| Phone | text |
| State | text |
| Tax ID | number |
| Vendor URL | url |
| IPN URL | url |
| Vendor Principal | object |
| First Name | text |
| Last Name | text |
| Address | text |
| City | text |
| ZIP | text |
| Country | text |
| Date of Birth | date |
| Personal Identification Number | number |
| Driver License Number | text |
| Payout Configuration | object |
| Review Delay | number |
| Payout Frequency | choice |
| Default Legal Entity | text |
| Regions | array |
| Vendor Agreement | object |
| Commission Percent | number |
| Account Status | choice |
| Field | Type |
|---|---|
| Vendor ID | number |
| text | |
| Name | text |
| First name | text |
| Last name | text |
| Address | text |
| City | text |
| Zip | text |
| Country | text |
| Phone | text |
| State | text |
| Vendor principal | object |
| First name | text |
| Last name | text |
| Address | text |
| City | text |
| Zip | text |
| Country | text |
| Dob | text |
| Personal identification number | text |
| Driver license number | text |
| text | |
| Payout configuration | object |
| Payout frequency | text |
| Review delay | number |
| Default legal entity | text |
| Regions | array |
| Vendor agreement | object |
| Commission percent | number |
| Account status | text |
| Recurring commission | text |
| Verification | object |
| Payout status | text |
| Processing status | text |
Templates
Look for BlueSnap templates in the WEXTL template library.
Browse templates →Other finance integrations on WEXTL
Checkout[2]Global payment platform for accepting cards, wallets, and alternative payment methods.
CapiumCloud accounting and practice management platform for accountants, covering invoicing, expenses, payments, and client communications.
dLocalCross-border payment infrastructure for accepting and disbursing funds in emerging markets across Latin America, Asia, and Africa.
ComanageOnline invoicing and accounting software for managing contacts, offers, invoices and payments.
BilltrustB2B accounts receivable and payment automation platform for invoices, collections, and cash application.
References
- WEXTL® BlueSnap Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for BlueSnap.
- WEXTL® visual workflow builder data.
Last updated: Jul 23, 2026 22:38
How we write our apps documentation
How we compile these docs — sources, AI's role, and how we verify.






























