Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://sandbox.bluesnap.com/services/2
/recurring/plans/{planId}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| planId | path | required | integer | BlueSnap identifier for the plan. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanUpdateRecurringPlanRequest"
}
}
}
}
PUT /recurring/plans/{planId}
/transactions
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReversalAuthTransactionRequest"
}
}
}
}
PUT /transactions
/vaulted-shoppers/{vaultedShopperId}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| vaultedShopperId | path | required | string | vaultedShopperId received from BlueSnap |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShopperUpdateVaultedShopperRequest"
}
}
}
}
PUT /vaulted-shoppers/{vaultedShopperId}
/recurring/subscriptions/{subscriptionId}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| subscriptionId | path | required | integer | BlueSnap identifier for the subscription. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionUpdateSubscriptionRequest"
}
}
}
}
PUT /recurring/subscriptions/{subscriptionId}
/alt-transactions
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionUpdatePaypalTransactionRequest"
}
}
}
}
PUT /alt-transactions
/transactions/approval
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| transactionid | query | optional | string | either `transactionid` or `merchanttransactionid` <b>is required</b> <br />ID of the transaction to be approved/declined |
| approvetransaction | query | optional | boolean | Set to `true` to approve the transaction or to `false` to decline the transaction. Default value is `true`. |
PUT /transactions/approval
/vendors/{vendorId}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| vendorId | path | required | integer | BlueSnap identifier for the vendor |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VendorUpdateVendorRequest"
}
}
}
}
PUT /vendors/{vendorId}
AuthorizationCreateTransactionRequest
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "float",
"default": 11
},
"currency": {
"type": "string",
"default": "USD"
},
"creditCard": {
"type": "object",
"properties": {
"cardNumber": {
"type": "string",
"default": "4263982640269299"
},
"securityCode": {
"type": "integer",
"format": "int32",
"default": 837
},
"expirationYear": {
"type": "integer",
"format": "int32",
"default": 2026
},
"expirationMonth": {
"type": "string",
"default": "02"
}
}
},
"cardHolderInfo": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"default": "02453"
},
"lastName": {
"type": "string",
"default": "test last name"
},
"firstName": {
"type": "string",
"default": "test first name"
}
}
},
"softDescriptor": {
"type": "string",
"default": "DescTest"
},
"cardTransactionType": {
"type": "string",
"default": "AUTH_ONLY"
}
}
}
PlanCreateRecurringPlanRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "Gold Plan"
},
"currency": {
"type": "string",
"default": "USD"
},
"chargeFrequency": {
"type": "string",
"default": "MONTHLY"
},
"gracePeriodDays": {
"type": "integer",
"format": "int32",
"default": 10
},
"trialPeriodDays": {
"type": "integer",
"format": "int32",
"default": 14
},
"chargeOnPlanSwitch": {
"type": "boolean",
"default": true
},
"maxNumberOfCharges": {
"type": "integer",
"format": "int32",
"default": 12
},
"initialChargeAmount": {
"type": "integer",
"format": "int32",
"default": 100
},
"recurringChargeAmount": {
"type": "number",
"format": "float",
"default": 29.99
}
}
}
PlanUpdateRecurringPlanRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "Gold Plan"
},
"currency": {
"type": "string",
"default": "USD"
},
"chargeFrequency": {
"type": "string",
"default": "MONTHLY"
},
"trialPeriodDays": {
"type": "string",
"default": "7"
},
"initialChargeAmount": {
"type": "string",
"default": "30"
},
"recurringChargeAmount": {
"type": "string",
"default": "29.99"
}
}
}
ReversalAuthTransactionRequest
{
"type": "object",
"properties": {
"transactionId": {
"type": "integer",
"format": "int32",
"default": 1011671987
},
"cardTransactionType": {
"type": "string",
"default": "AUTH_REVERSAL"
}
}
}
ShopperCreateVaultedShopperRequest
{
"type": "object",
"properties": {
"lastName": {
"type": "string",
"default": "LastName"
},
"firstName": {
"type": "string",
"default": "FirstName"
},
"paymentSources": {
"type": "object",
"properties": {
"creditCardInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"creditCard": {
"type": "object",
"properties": {
"cardNumber": {
"type": "string",
"default": "4263982640269299"
},
"securityCode": {
"type": "string",
"default": "837"
},
"expirationYear": {
"type": "integer",
"format": "int32",
"default": 2023
},
"expirationMonth": {
"type": "integer",
"format": "int32",
"default": 2
}
}
}
}
}
}
}
}
}
}
ShopperUpdateVaultedShopperRequest
{
"type": "object",
"properties": {
"lastName": {
"type": "string",
"default": "LastName"
},
"firstName": {
"type": "string",
"default": "FirstName"
},
"paymentSources": {
"type": "object",
"properties": {
"creditCardInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"creditCard": {
"type": "object",
"properties": {
"cardNumber": {
"type": "string",
"default": "4263982640269299"
},
"securityCode": {
"type": "string",
"default": "837"
},
"expirationYear": {
"type": "integer",
"format": "int32",
"default": 2023
},
"expirationMonth": {
"type": "integer",
"format": "int32",
"default": 2
}
}
}
}
}
}
}
}
}
}
SubscriptionCreateMerchantManagedChargeRequest
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "float",
"default": 45
},
"currency": {
"type": "string",
"default": "USD"
},
"taxReference": {
"type": "string",
"default": "048deff0-a285-47e1-bc39-42f79bf0095b"
},
"merchantTransactionId": {
"type": "string",
"default": "MyUniqueOnDemandSubscription"
}
}
}
SubscriptionCreateMerchantManagedSubscriptionRequest
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "float",
"default": 45
},
"currency": {
"type": "string",
"default": "USD"
},
"payerInfo": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"default": "02453"
},
"country": {
"type": "string",
"default": "us"
},
"lastName": {
"type": "string",
"default": "Doe"
},
"firstName": {
"type": "string",
"default": "John"
}
}
},
"paymentSource": {
"type": "object",
"properties": {
"creditCardInfo": {
"type": "object",
"properties": {
"creditCard": {
"type": "object",
"properties": {
"cardNumber": {
"type": "string",
"default": "4012000033330026"
},
"securityCode": {
"type": "string",
"default": "111"
},
"expirationYear": {
"type": "integer",
"format": "int32",
"default": 2026
},
"expirationMonth": {
"type": "integer",
"format": "int32",
"default": 5
}
}
}
}
}
}
}
}
}
SubscriptionCreateNewRequest
{
"type": "object",
"properties": {
"planId": {
"type": "integer",
"format": "int32",
"default": 2283845
},
"payerInfo": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"default": "02453"
},
"phone": {
"type": "string",
"default": "1234567890"
},
"lastName": {
"type": "string",
"default": "Doe"
},
"firstName": {
"type": "string",
"default": "John"
}
}
},
"paymentSource": {
"type": "object",
"properties": {
"creditCardInfo": {
"type": "object",
"properties": {
"creditCard": {
"type": "object",
"properties": {
"cardNumber": {
"type": "string",
"default": "4111111111111111"
},
"securityCode": {
"type": "string",
"default": "111"
},
"expirationYear": {
"type": "integer",
"format": "int32",
"default": 2023
},
"expirationMonth": {
"type": "string",
"default": "07"
}
}
}
}
}
}
}
}
}
SubscriptionUpdateSubscriptionRequest
{
"type": "object",
"properties": {
"planId": {
"type": "string",
"default": "2283849"
}
}
}
TransactionCreateBatchTransactionRequest
{
"type": "object",
"properties": {
"batchTransaction": {
"type": "object",
"properties": {
"batchId": {
"type": "string",
"default": "567890"
},
"callbackUrl": {
"type": "string",
"default": "http://example.com/batch_callback"
},
"cardTransaction": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"default": "20.00"
},
"currency": {
"type": "string",
"default": "USD"
},
"creditCard": {
"type": "object",
"properties": {
"": {
"type": "string"
},
"cardNumber": {
"type": "string",
"default": "4263982640269299"
},
"expirationYear": {
"type": "string",
"default": "2023"
},
"expirationMonth": {
"type": "string",
"default": "02"
}
}
},
"cardHolderInfo": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"default": "02453"
},
"lastName": {
"type": "string",
"default": "test last name"
},
"firstName": {
"type": "string",
"default": "test first name"
}
}
},
"cardTransactionType": {
"type": "string",
"default": "AUTH_CAPTURE"
},
"merchantTransactionId": {
"type": "string",
"default": "566"
}
}
}
}
}
}
}
}
TransactionCreateSofortTransactionRequest
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "float",
"default": 42
},
"currency": {
"type": "string",
"default": "EUR"
},
"payerInfo": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"default": "12345"
},
"phone": {
"type": "string",
"default": "1234567890"
},
"country": {
"type": "string",
"default": "uk"
},
"lastName": {
"type": "string",
"default": "Doe"
},
"firstName": {
"type": "string",
"default": "John"
}
}
},
"ecpTransaction": {
"type": "object",
"properties": {
"accountType": {
"type": "string",
"default": "CONSUMER_CHECKING"
},
"accountNumber": {
"type": "integer",
"format": "int32",
"default": 4099999992
},
"routingNumber": {
"type": "string",
"default": "011075150"
}
}
},
"softDescriptor": {
"type": "string",
"default": "ABC COMPANY"
},
"idealTransaction": {
"type": "object",
"properties": {
"returnUrl": {
"type": "string",
"default": "http://www.returnURL.com"
}
}
},
"paypalTransaction": {
"type": "object",
"properties": {
"cancelUrl": {
"type": "string",
"default": "http://www.cancelURL.com"
},
"returnUrl": {
"type": "string",
"default": "http://www.returnURL.com"
},
"transactionType": {
"type": "string",
"default": "SET_ORDER"
}
}
},
"sofortTransaction": {
"type": "object",
"properties": {
"returnUrl": {
"type": "string",
"default": "http://www.returnURL.com"
}
}
},
"authorizedByShopper": {
"type": "boolean",
"default": true
},
"acssDirectDebitTransaction": {
"type": "object",
"properties": {
"accountType": {
"type": "string",
"default": "PERSONAL"
},
"agreementId": {
"type": "integer",
"format": "int32",
"default": 87
},
"accountNumber": {
"type": "string",
"default": "9990000001"
},
"routingNumber": {
"type": "string",
"default": "001004820"
}
}
},
"becsDirectDebitTransaction": {
"type": "object",
"properties": {
"bsbNumber": {
"type": "string",
"default": "980201"
},
"branchName": {
"type": "string",
"default": "branchName"
},
"accountName": {
"type": "string",
"default": "Boris Britva"
},
"agreementId": {
"type": "integer",
"format": "int32",
"default": 81
},
"accountNumber": {
"type": "string",
"default": "9990000001"
},
"financialInstitution": {
"type": "string",
"default": "financialInstitution"
}
}
},
"sepaDirectDebitTransaction": {
"type": "object",
"properties": {
"iban": {
"type": "string",
"default": "DE09100100101234567893"
}
}
},
"localBankTransferTransaction": {
"type": "object",
"properties": {
"{}": {
"type": "string"
}
},
"description": "empty object"
}
}
}
TransactionInitiateRefundRequest
{
"type": "object",
"properties": {
"reason": {
"type": "string",
"default": "Refund for order #1992"
},
"cancelSubscriptions": {
"type": "boolean",
"default": false
},
"transactionMetaData": {
"type": "object",
"properties": {
"metaData": {
"type": "array",
"items": {
"type": "object",
"properties": {
"metaKey": {
"type": "string",
"default": "refundedItems"
},
"metaValue": {
"type": "string",
"default": 15528832
},
"metaDescription": {
"type": "string",
"default": "Refunded Items"
}
}
}
}
}
}
}
}
TransactionUpdatePaypalTransactionRequest
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "float",
"default": 105
},
"currency": {
"type": "string",
"default": "USD"
},
"paypalTransaction": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"default": "7078033"
},
"transactionType": {
"type": "string",
"default": "DO_ORDER"
}
}
}
}
}
VendorCreateRequest
{
"type": "object",
"properties": {
"zip": {
"type": "string",
"default": "02453"
},
"city": {
"type": "string",
"default": "Boston"
},
"email": {
"type": "string",
"default": "vendor@example.com"
},
"phone": {
"type": "string",
"default": "1-123-456-7890"
},
"state": {
"type": "string",
"default": "MA"
},
"ipnUrl": {
"type": "string",
"default": "https://ipnaddress.com"
},
"address": {
"type": "string",
"default": "123 Main Street"
},
"country": {
"type": "string",
"default": "US"
},
"lastName": {
"type": "string",
"default": "Smith"
},
"firstName": {
"type": "string",
"default": "Joe"
},
"payoutInfo": {
"type": "object",
"properties": {}
},
"vendorAgreement": {
"type": "object",
"properties": {
"commissionPercent": {
"type": "integer",
"format": "int32",
"default": 30
}
}
},
"vendorPrincipal": {
"type": "object",
"properties": {
"dob": {
"type": "string",
"default": "28-09-9999"
},
"zip": {
"type": "string",
"default": "02453"
},
"city": {
"type": "string",
"default": "Boston"
},
"email": {
"type": "string",
"default": "individual.vendor@bluesnap.com"
},
"address": {
"type": "string",
"default": "123 Main Street"
},
"country": {
"type": "string",
"default": "US"
},
"lastName": {
"type": "string",
"default": "Smith"
},
"firstName": {
"type": "string",
"default": "Joe"
},
"driverLicenseNumber": {
"type": "string",
"default": "561196411"
},
"personalIdentificationNumber": {
"type": "string",
"default": "1234"
}
}
},
"defaultPayoutCurrency": {
"type": "string",
"default": "USD"
}
}
}
VendorUpdateVendorRequest
{
"type": "object",
"properties": {
"zip": {
"type": "string",
"default": "02453"
},
"city": {
"type": "string",
"default": "testing city"
},
"name": {
"type": "string",
"default": "Important Vendor"
},
"email": {
"type": "string",
"default": "vendor@bluesnap.com"
},
"phone": {
"type": "string",
"default": "1-054-976-6778"
},
"state": {
"type": "string",
"default": "MA"
},
"taxId": {
"type": "integer",
"format": "int32",
"default": 123456789
},
"ipnUrl": {
"type": "string",
"default": "https://ipnaddress.com"
},
"address": {
"type": "string",
"default": "123 Main Street"
},
"country": {
"type": "string",
"default": "US"
},
"lastName": {
"type": "string",
"default": "Smith"
},
"firstName": {
"type": "string",
"default": "Joe"
},
"vendorUrl": {
"type": "string",
"default": "http://mycompany.com"
},
"payoutInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"default": "02453"
},
"city": {
"type": "string",
"default": "Portland"
},
"state": {
"type": "string",
"default": "MA"
},
"bankId": {
"type": "string",
"default": "123456789"
},
"address": {
"type": "string",
"default": "1 bank address"
},
"country": {
"type": "string",
"default": "US"
},
"bankName": {
"type": "string",
"default": "Leumi"
},
"payoutType": {
"type": "string",
"default": "ACH"
},
"baseCurrency": {
"type": "string",
"default": "USD"
},
"bankAccountId": {
"type": "string",
"default": "123456789"
},
"nameOnAccount": {
"type": "string",
"default": "vendor"
},
"refundReserve": {
"type": "integer",
"format": "int32",
"default": 200
},
"bankAccountType": {
"type": "string",
"default": "CHECKING"
},
"bankAccountClass": {
"type": "string",
"default": "PERSONAL"
},
"paymentReference": {
"type": "string",
"default": "Payment for vendor 1234"
},
"minimalPayoutAmount": {
"type": "integer",
"format": "int32",
"default": 50
}
}
}
},
"vendorAgreement": {
"type": "object",
"properties": {
"accountStatus": {
"type": "string",
"default": "ACTIVE"
},
"commissionPercent": {
"type": "integer",
"format": "int32",
"default": 20
}
}
},
"vendorPrincipal": {
"type": "object",
"properties": {
"dob": {
"type": "string",
"default": "28-09-9999"
},
"zip": {
"type": "string",
"default": "02453"
},
"city": {
"type": "string",
"default": "Juneau"
},
"email": {
"type": "string",
"default": "principal.name@vendor.com"
},
"address": {
"type": "string",
"default": "123 Main Street"
},
"country": {
"type": "string",
"default": "US"
},
"lastName": {
"type": "string",
"default": "Smith"
},
"firstName": {
"type": "string",
"default": "Joe"
},
"driverLicenseNumber": {
"type": "string",
"default": "561196411"
},
"personalIdentificationNumber": {
"type": "integer",
"format": "int32",
"default": 1234
}
}
},
"defaultPayoutCurrency": {
"type": "string",
"default": "USD"
}
}
}