Create merchant. If a merchant with the given device IMEI already exists for this account, it will return the existing merchant. Note: Phone numbers are not used for deduplication.
TalusPay API (v1)
The Talus Pay API is organized into two main areas: Merchant Onboarding and Payments. The Merchant Onboarding endpoints are designed to facilitate the registration, verification, and configuration of new merchants within the platform. This includes creating merchant accounts, submitting necessary documentation, and managing compliance checks.
On the other hand, the Payments endpoints focus on transaction processing, allowing merchants to accept payments, initiate refunds, and handle transaction statuses. This section is structured to manage payment methods, securely process card transactions, and retrieve transaction histories, ensuring a smooth flow of payment operations for merchants. Together, these two areas provide comprehensive support for managing both the setup and ongoing financial activities of merchants.
The TalusPay status page provides real-time updates on the operational status of API services, including onboarding and payments, as well as historical uptime data. You can check the current service status at Status page
Download OpenAPI description
Overview
URL
TalusPay
Languages
Servers
Mock server
https://docs.taluspay.com/_mock/openapi/
Production environment onboarding
https://api.taluspay.com/
Sandbox environment onboarding
https://api.taluspay-sandbox.com/
- Mock serverhttps://docs.taluspay.com/_mock/openapi/v1/merchants
- Production environment onboardinghttps://api.taluspay.com/v1/merchants
- Sandbox environment onboardinghttps://api.taluspay-sandbox.com/v1/merchants
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://docs.taluspay.com/_mock/openapi/v1/merchants \
-H 'Content-Type: application/json' \
-d '{
"phone": "string",
"device": {
"imei": "357111112222333"
},
"merchant": {
"legal_business_name": "string",
"legal_phone": "string",
"business_phone": "string",
"business_type": "Sole Proprietor",
"bank_account": {
"bank_name": "string",
"routing_number": "string",
"account_holder_name": "string",
"account_number": "string",
"account_number_confirm": "string"
},
"tin": "string",
"tin_type": "EIN",
"doing_business_as": "string",
"business_established_date": "string",
"legal_business_address": {
"address": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"dba_address": {
"address": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"owner_one": {
"first_name": "string",
"contact_phone": "string",
"last_name": "string",
"middle_name": "string",
"job_title": "President",
"ownership_percentage": "25",
"email": "string",
"date_of_birth": "string",
"home_address": {
"address": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"ssn": "string"
},
"owner_two": {
"first_name": "string",
"contact_phone": "string",
"last_name": "string",
"middle_name": "string",
"job_title": "President",
"ownership_percentage": "25",
"email": "string",
"date_of_birth": "string",
"home_address": {
"address": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"ssn": "string"
},
"owner_three": {
"first_name": "string",
"contact_phone": "string",
"last_name": "string",
"middle_name": "string",
"job_title": "President",
"ownership_percentage": "25",
"email": "string",
"date_of_birth": "string",
"home_address": {
"address": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"ssn": "string"
},
"owner_four": {
"first_name": "string",
"contact_phone": "string",
"last_name": "string",
"middle_name": "string",
"job_title": "President",
"ownership_percentage": "25",
"email": "string",
"date_of_birth": "string",
"home_address": {
"address": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"ssn": "string"
},
"main_product": {
"description": "string",
"category": "Apparel",
"subcategory": "Veterinary Services",
"website": "string"
},
"main_contact_person": {
"name": "string",
"email": "string"
},
"current_sales": {
"average_monthly_in_credit_card": "string",
"average_ticket_value": "string",
"highest_amount_to_date": "string",
"sales_percentage": {
"card_swipe_percentage": "string",
"moto_percentage": "string",
"online_percentage": "string",
"keyed_percentage": "string"
},
"average_amex_monthly_sales": "string",
"average_amex_ticket_value": "string"
},
"bank_account_results": "string",
"capabilities": {
"types": [
"two_tiered",
"ach"
],
"options": {
"two_tiered": {
"vmd_cp_rate_percent": "2.00",
"vmd_cp_fee_fixed": "0.10",
"vmd_cnp_rate_percent": "2.50",
"vmd_cnp_fee_fixed": "0.15",
"amex_cp_rate_percent": "3.10",
"amex_cp_fee_fixed": "0.25",
"amex_cnp_rate_percent": "3.50",
"amex_cnp_fee_fixed": "0.30"
},
"ach": {
"txn_fee_percent": "1.50",
"txn_fee_fixed": "0.25"
}
}
},
"fees": {
"monthly": {
"minimum_processing_fee": 35,
"merchant_advance_service_charge": 35
}
}
},
"agent": 0
}' Enum"Sole Proprietor""Limited Liability (LLC)""Partnership""Association/State & Trust""Tax Exempt Org""Corporation"
Enum"President""Vice President""Treasurer""Owner""Partner""CEO""Secretary""Director""Controller""Accountant"
Ownership percentage as a numeric value between 0 and 100 (without % symbol)
Example: "25"
Enum"Apparel""B2B""Construction""Education""Entertainment""Financial Services""Grocery and Food""Lodging""Medical""Restaurants"
Enum"Veterinary Services""Agricultural Cooperatives""Landscaping Services""Miscellaneous Publishing and Printing Services""Typesetting, Plate Making and Related Services (Business to Business MCC)""Specialty Cleaning, Polishing and Sanitation Preparations (Business to Business MCC)""Equipment Sales""Tailors, Seamstresses, Mending, Alterations""Laundry, Cleaning, and Garment Services""Laundromats"
URL to redirect after completing a transaction
Example: "https://merchant-site.com/thank-you"
Custom domain for merchant onboarding
Example: "https://apply.example.com"
Capability types
Items Enum"two_tiered""pass_through_ic""flat_rate""tiered""cash_discount""ach"
Example: ["two_tiered","ach"]
Visa/Mastercard card present rate percent
Example: "2.00"
Visa/Mastercard card present fee fixed
Example: "0.10"
Visa/Mastercard card not present rate percent
Example: "2.50"
Visa/Mastercard card not present fee fixed
Example: "0.15"
Amex card present rate percent
Example: "3.10"
Amex card present fee fixed
Example: "0.25"
Amex card not present rate percent
Example: "3.50"
Processor markup percent
Example: "0.10"
Transaction fee fixed
Example: "0.10"
Visa/Mastercard credit discount percent
Visa/Mastercard credit fee fixed
Visa/Mastercard debit discount percent
Visa/Mastercard debit fee fixed
Amex discount percent
Flat rate percent
Example: "2.90"
Visa/Mastercard credit rate percent
Visa/Mastercard credit fee fixed
Visa/Mastercard debit rate percent
Visa/Mastercard debit fee fixed
Visa/Mastercard qualified credit rate percent
Example: "1.79"
Visa/Mastercard mid-qualified credit rate percent
Example: "2.19"
Visa/Mastercard mid-qualified credit fee fixed
Example: "0.15"
Visa/Mastercard non-qualified credit rate percent
Example: "3.25"
Visa/Mastercard non-qualified credit fee fixed
Example: "0.20"
Visa/Mastercard qualified debit rate percent
Example: "1.50"
Visa/Mastercard mid-qualified debit rate percent
Example: "1.90"
Visa/Mastercard mid-qualified debit fee fixed
Example: "0.12"
Visa/Mastercard non-qualified debit rate percent
Example: "2.95"
Visa/Mastercard non-qualified debit fee fixed
Example: "0.18"
Amex qualified credit rate percent
Example: "2.89"
Amex mid-qualified credit rate percent
Example: "3.29"
Amex mid-qualified credit fee fixed
Example: "0.25"
Amex non-qualified credit rate percent
Example: "4.35"
Amex non-qualified credit fee fixed
Example: "0.30"
Qualified rate percent (legacy)
Example: "1.79"
Qualified fee fixed (legacy)
Example: "0.10"
Mid-qualified rate percent (legacy)
Example: "2.19"
Mid-qualified fee fixed (legacy)
Example: "0.15"
Non-qualified rate percent (legacy)
Example: "3.25"
ACH transaction fixed fee
Example: "0.25"
ACH transaction percentage fee
Example: "0.75"
ACH return fixed fee
Example: "5.00"
ACH chargeback fixed fee
Example: "10.00"
ACH transaction premium fixed fee
Example: "0.30"
ACH daily batch fee
Example: "1.00"
ACH return reversal fee
Example: "7.50"
ACH gross volume discount rate
Example: "2.50"
Response
application/json
{ "id": "merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k", "phone": "12819374192", "automatic_payouts": true, "deactivated": true, "created_at": "2019-08-24T14:15:22Z", "lead_id": 0, "lead_onboarding_status": "NOT_STARTED", "merchant": { "legal_business_name": "string", "legal_phone": "string", "business_phone": "string", "business_type": "Sole Proprietor", "bank_account": { … }, "tin": "string", "tin_type": "EIN", "doing_business_as": "string", "business_established_date": "string", "legal_business_address": { … }, "dba_address": { … }, "owner_one": { … }, "owner_two": { … }, "owner_three": { … }, "owner_four": { … }, "main_product": { … }, "main_contact_person": { … }, "current_sales": { … }, "bank_account_results": "string", "capabilities": { … }, "fees": { … } }, "payment": { "tokenizer_publishable_key": "pub_XXXXXXXXXXXXXX", "terminal_id": "Cx78a65ada9" }, "defaults": { "display_name": "My Store", "logo": "https://example.com/logo.png", "primary_color": "#FF5733", "secondary_color": "#FF5733", "redirect_url": "https://merchant-site.com/thank-you", "custom_domain": "https://apply.example.com", "support": {} }, "default_capabilities": { "types": [ … ], "options": { … } }, "payment_keys": {}, "device": { "id": "dev_2x4y6z8a0b1c2d3e4f5g6h7j8k", "imei": "357111112222333", "imei_status": "ACTIVE", "created_at": "2024-01-15T10:30:00.000Z", "updated_at": "2024-01-15T10:30:00.000Z" } }
- Mock serverhttps://docs.taluspay.com/_mock/openapi/v1/merchants
- Production environment onboardinghttps://api.taluspay.com/v1/merchants
- Sandbox environment onboardinghttps://api.taluspay-sandbox.com/v1/merchants
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.taluspay.com/_mock/openapi/v1/merchants?filter.lead.onboardingStatus=NOT_STARTED&filter.deactivated=false&filter.phoneNumber=%2B1234567890&filter.sid=merchant_01234567890abcdef&sortBy=createdAt%3ADESC&limit=20&page=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'List all merchants for the account with pagination
List of merchants
Enum"NOT_STARTED""IN_PROGRESS""COMPLETED""APPROVED""FAILED"
Enum"Sole Proprietor""Limited Liability (LLC)""Partnership""Association/State & Trust""Tax Exempt Org""Corporation"
Enum"President""Vice President""Treasurer""Owner""Partner""CEO""Secretary""Director""Controller""Accountant"
Ownership percentage as a numeric value between 0 and 100 (without % symbol)
Example: "25"
Enum"Apparel""B2B""Construction""Education""Entertainment""Financial Services""Grocery and Food""Lodging""Medical""Restaurants"
Enum"Veterinary Services""Agricultural Cooperatives""Landscaping Services""Miscellaneous Publishing and Printing Services""Typesetting, Plate Making and Related Services (Business to Business MCC)""Specialty Cleaning, Polishing and Sanitation Preparations (Business to Business MCC)""Equipment Sales""Tailors, Seamstresses, Mending, Alterations""Laundry, Cleaning, and Garment Services""Laundromats"
Display name for the merchant
Example: "My Store"
Logo URL for the merchant
Example: "https://example.com/logo.png"
Primary color for merchant branding
Example: "#FF5733"
Secondary color for merchant branding
Example: "#FF5733"
URL to redirect after completing a transaction
Example: "https://merchant-site.com/thank-you"
Custom domain for merchant onboarding
Example: "https://apply.example.com"
Capability types
Items Enum"two_tiered""pass_through_ic""flat_rate""tiered""cash_discount""ach"
Example: ["two_tiered","ach"]
Visa/Mastercard card present rate percent
Example: "2.00"
Visa/Mastercard card present fee fixed
Example: "0.10"
Visa/Mastercard card not present rate percent
Example: "2.50"
Visa/Mastercard card not present fee fixed
Example: "0.15"
Amex card present rate percent
Example: "3.10"
Amex card present fee fixed
Example: "0.25"
Amex card not present rate percent
Example: "3.50"
merchants[].​default_capabilities.​options.​pass_through_ic.​processor_markup_percentstringrequired
Processor markup percent
Example: "0.10"
merchants[].​default_capabilities.​options.​pass_through_ic.​transaction_fee_fixedstringrequired
Transaction fee fixed
Example: "0.10"
merchants[].​default_capabilities.​options.​pass_through_ic.​vmd_credit_discount_percentstringrequired
Visa/Mastercard credit discount percent
merchants[].​default_capabilities.​options.​pass_through_ic.​vmd_credit_fee_fixedstringrequired
Visa/Mastercard credit fee fixed
merchants[].​default_capabilities.​options.​pass_through_ic.​vmd_debit_discount_percentstringrequired
Visa/Mastercard debit discount percent
merchants[].​default_capabilities.​options.​pass_through_ic.​vmd_debit_fee_fixedstringrequired
Visa/Mastercard debit fee fixed
Flat rate percent
Example: "2.90"
Fee fixed
Example: "0.30"
merchants[].​default_capabilities.​options.​flat_rate.​vmd_credit_rate_percentstringrequired
Visa/Mastercard credit rate percent
Visa/Mastercard credit fee fixed
Visa/Mastercard debit rate percent
Visa/Mastercard debit fee fixed
Amex rate percent
merchants[].​default_capabilities.​options.​tiered.​vmd_qual_credit_rate_percentstringrequired
Visa/Mastercard qualified credit rate percent
Example: "1.79"
merchants[].​default_capabilities.​options.​tiered.​vmd_midq_credit_rate_percentstringrequired
Visa/Mastercard mid-qualified credit rate percent
Example: "2.19"
Visa/Mastercard mid-qualified credit fee fixed
Example: "0.15"
merchants[].​default_capabilities.​options.​tiered.​vmd_nonq_credit_rate_percentstringrequired
Visa/Mastercard non-qualified credit rate percent
Example: "3.25"
Visa/Mastercard non-qualified credit fee fixed
Example: "0.20"
merchants[].​default_capabilities.​options.​tiered.​vmd_qual_debit_rate_percentstringrequired
Visa/Mastercard qualified debit rate percent
Example: "1.50"
merchants[].​default_capabilities.​options.​tiered.​vmd_midq_debit_rate_percentstringrequired
Visa/Mastercard mid-qualified debit rate percent
Example: "1.90"
Visa/Mastercard mid-qualified debit fee fixed
Example: "0.12"
merchants[].​default_capabilities.​options.​tiered.​vmd_nonq_debit_rate_percentstringrequired
Visa/Mastercard non-qualified debit rate percent
Example: "2.95"
Visa/Mastercard non-qualified debit fee fixed
Example: "0.18"
merchants[].​default_capabilities.​options.​tiered.​amex_qual_credit_rate_percentstringrequired
Amex qualified credit rate percent
Example: "2.89"
merchants[].​default_capabilities.​options.​tiered.​amex_midq_credit_rate_percentstringrequired
Amex mid-qualified credit rate percent
Example: "3.29"
merchants[].​default_capabilities.​options.​tiered.​amex_midq_credit_fee_fixedstringrequired
Amex mid-qualified credit fee fixed
Example: "0.25"
merchants[].​default_capabilities.​options.​tiered.​amex_nonq_credit_rate_percentstringrequired
Amex non-qualified credit rate percent
Example: "4.35"
merchants[].​default_capabilities.​options.​tiered.​amex_nonq_credit_fee_fixedstringrequired
Amex non-qualified credit fee fixed
Example: "0.30"
Qualified rate percent (legacy)
Example: "1.79"
Qualified fee fixed (legacy)
Example: "0.10"
merchants[].​default_capabilities.​options.​tiered.​mid_qualified_rate_percentstringrequired
Mid-qualified rate percent (legacy)
Example: "2.19"
Mid-qualified fee fixed (legacy)
Example: "0.15"
ACH transaction fixed fee
Example: "0.25"
ACH transaction percentage fee
Example: "0.75"
ACH return fixed fee
Example: "5.00"
ACH chargeback fixed fee
Example: "10.00"
ACH transaction premium fixed fee
Example: "0.30"
ACH monthly fee
Example: "25.00"
ACH daily batch fee
Example: "1.00"
ACH return reversal fee
Example: "7.50"
ACH gross volume discount rate
Example: "2.50"
Response
application/json
{ "merchants": [ { … } ], "pagination": { "page": 1, "limit": 20, "total": 150, "total_pages": 8, "has_next": true, "has_previous": false } }
- Mock serverhttps://docs.taluspay.com/_mock/openapi/v1/merchants/{merchant_id}
- Production environment onboardinghttps://api.taluspay.com/v1/merchants/{merchant_id}
- Sandbox environment onboardinghttps://api.taluspay-sandbox.com/v1/merchants/{merchant_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.taluspay.com/_mock/openapi/v1/merchants/{merchant_id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Get merchant object
Enum"Sole Proprietor""Limited Liability (LLC)""Partnership""Association/State & Trust""Tax Exempt Org""Corporation"
Enum"President""Vice President""Treasurer""Owner""Partner""CEO""Secretary""Director""Controller""Accountant"
Ownership percentage as a numeric value between 0 and 100 (without % symbol)
Example: "25"
Enum"Apparel""B2B""Construction""Education""Entertainment""Financial Services""Grocery and Food""Lodging""Medical""Restaurants"
Enum"Veterinary Services""Agricultural Cooperatives""Landscaping Services""Miscellaneous Publishing and Printing Services""Typesetting, Plate Making and Related Services (Business to Business MCC)""Specialty Cleaning, Polishing and Sanitation Preparations (Business to Business MCC)""Equipment Sales""Tailors, Seamstresses, Mending, Alterations""Laundry, Cleaning, and Garment Services""Laundromats"
URL to redirect after completing a transaction
Example: "https://merchant-site.com/thank-you"
Custom domain for merchant onboarding
Example: "https://apply.example.com"
Capability types
Items Enum"two_tiered""pass_through_ic""flat_rate""tiered""cash_discount""ach"
Example: ["two_tiered","ach"]
Visa/Mastercard card present rate percent
Example: "2.00"
Visa/Mastercard card present fee fixed
Example: "0.10"
Visa/Mastercard card not present rate percent
Example: "2.50"
Visa/Mastercard card not present fee fixed
Example: "0.15"
Amex card present rate percent
Example: "3.10"
Amex card present fee fixed
Example: "0.25"
Amex card not present rate percent
Example: "3.50"
Processor markup percent
Example: "0.10"
Transaction fee fixed
Example: "0.10"
Visa/Mastercard credit discount percent
Visa/Mastercard credit fee fixed
Visa/Mastercard debit discount percent
Visa/Mastercard debit fee fixed
Amex discount percent
Flat rate percent
Example: "2.90"
Visa/Mastercard credit rate percent
Visa/Mastercard credit fee fixed
Visa/Mastercard debit rate percent
Visa/Mastercard debit fee fixed
Visa/Mastercard qualified credit rate percent
Example: "1.79"
Visa/Mastercard mid-qualified credit rate percent
Example: "2.19"
Visa/Mastercard mid-qualified credit fee fixed
Example: "0.15"
Visa/Mastercard non-qualified credit rate percent
Example: "3.25"
Visa/Mastercard non-qualified credit fee fixed
Example: "0.20"
Visa/Mastercard qualified debit rate percent
Example: "1.50"
Visa/Mastercard mid-qualified debit rate percent
Example: "1.90"
Visa/Mastercard mid-qualified debit fee fixed
Example: "0.12"
Visa/Mastercard non-qualified debit rate percent
Example: "2.95"
Visa/Mastercard non-qualified debit fee fixed
Example: "0.18"
Amex qualified credit rate percent
Example: "2.89"
Amex mid-qualified credit rate percent
Example: "3.29"
Amex mid-qualified credit fee fixed
Example: "0.25"
Amex non-qualified credit rate percent
Example: "4.35"
Amex non-qualified credit fee fixed
Example: "0.30"
Qualified rate percent (legacy)
Example: "1.79"
Qualified fee fixed (legacy)
Example: "0.10"
Mid-qualified rate percent (legacy)
Example: "2.19"
Mid-qualified fee fixed (legacy)
Example: "0.15"
Non-qualified rate percent (legacy)
Example: "3.25"
ACH transaction fixed fee
Example: "0.25"
ACH transaction percentage fee
Example: "0.75"
ACH return fixed fee
Example: "5.00"
ACH chargeback fixed fee
Example: "10.00"
ACH transaction premium fixed fee
Example: "0.30"
ACH daily batch fee
Example: "1.00"
ACH return reversal fee
Example: "7.50"
ACH gross volume discount rate
Example: "2.50"
Response
application/json
{ "id": "merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k", "phone": "12819374192", "automatic_payouts": true, "deactivated": true, "created_at": "2019-08-24T14:15:22Z", "lead_id": 0, "lead_onboarding_status": "NOT_STARTED", "merchant": { "legal_business_name": "string", "legal_phone": "string", "business_phone": "string", "business_type": "Sole Proprietor", "bank_account": { … }, "tin": "string", "tin_type": "EIN", "doing_business_as": "string", "business_established_date": "string", "legal_business_address": { … }, "dba_address": { … }, "owner_one": { … }, "owner_two": { … }, "owner_three": { … }, "owner_four": { … }, "main_product": { … }, "main_contact_person": { … }, "current_sales": { … }, "bank_account_results": "string", "capabilities": { … }, "fees": { … } }, "payment": { "tokenizer_publishable_key": "pub_XXXXXXXXXXXXXX", "terminal_id": "Cx78a65ada9" }, "defaults": { "display_name": "My Store", "logo": "https://example.com/logo.png", "primary_color": "#FF5733", "secondary_color": "#FF5733", "redirect_url": "https://merchant-site.com/thank-you", "custom_domain": "https://apply.example.com", "support": {} }, "default_capabilities": { "types": [ … ], "options": { … } }, "payment_keys": {}, "device": { "id": "dev_2x4y6z8a0b1c2d3e4f5g6h7j8k", "imei": "357111112222333", "imei_status": "ACTIVE", "created_at": "2024-01-15T10:30:00.000Z", "updated_at": "2024-01-15T10:30:00.000Z" } }
Bodyapplication/jsonrequired
Enum"Sole Proprietor""Limited Liability (LLC)""Partnership""Association/State & Trust""Tax Exempt Org""Corporation"
Enum"President""Vice President""Treasurer""Owner""Partner""CEO""Secretary""Director""Controller""Accountant"
Ownership percentage as a numeric value between 0 and 100 (without % symbol)
Example: "25"
Enum"Apparel""B2B""Construction""Education""Entertainment""Financial Services""Grocery and Food""Lodging""Medical""Restaurants"
Enum"Veterinary Services""Agricultural Cooperatives""Landscaping Services""Miscellaneous Publishing and Printing Services""Typesetting, Plate Making and Related Services (Business to Business MCC)""Specialty Cleaning, Polishing and Sanitation Preparations (Business to Business MCC)""Equipment Sales""Tailors, Seamstresses, Mending, Alterations""Laundry, Cleaning, and Garment Services""Laundromats"
- Mock serverhttps://docs.taluspay.com/_mock/openapi/v1/merchants/{merchant_id}
- Production environment onboardinghttps://api.taluspay.com/v1/merchants/{merchant_id}
- Sandbox environment onboardinghttps://api.taluspay-sandbox.com/v1/merchants/{merchant_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
-u <username>:<password> \
'https://docs.taluspay.com/_mock/openapi/v1/merchants/{merchant_id}' \
-H 'Content-Type: application/json' \
-d '{
"legal_business_name": "string",
"legal_phone": "string",
"business_phone": "string",
"business_type": "Sole Proprietor",
"bank_account": {
"bank_name": "string",
"routing_number": "string",
"account_holder_name": "string",
"account_number": "string",
"account_number_confirm": "string"
},
"tin": "string",
"tin_type": "EIN",
"doing_business_as": "string",
"business_established_date": "string",
"legal_business_address": {
"address": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"dba_address": {
"address": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"owner_one": {
"first_name": "string",
"contact_phone": "string",
"last_name": "string",
"middle_name": "string",
"job_title": "President",
"ownership_percentage": "25",
"email": "string",
"date_of_birth": "string",
"home_address": {
"address": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"ssn": "string"
},
"owner_two": {
"first_name": "string",
"contact_phone": "string",
"last_name": "string",
"middle_name": "string",
"job_title": "President",
"ownership_percentage": "25",
"email": "string",
"date_of_birth": "string",
"home_address": {
"address": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"ssn": "string"
},
"owner_three": {
"first_name": "string",
"contact_phone": "string",
"last_name": "string",
"middle_name": "string",
"job_title": "President",
"ownership_percentage": "25",
"email": "string",
"date_of_birth": "string",
"home_address": {
"address": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"ssn": "string"
},
"owner_four": {
"first_name": "string",
"contact_phone": "string",
"last_name": "string",
"middle_name": "string",
"job_title": "President",
"ownership_percentage": "25",
"email": "string",
"date_of_birth": "string",
"home_address": {
"address": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"ssn": "string"
},
"main_product": {
"description": "string",
"category": "Apparel",
"subcategory": "Veterinary Services",
"website": "string"
},
"main_contact_person": {
"name": "string",
"email": "string"
},
"current_sales": {
"average_monthly_in_credit_card": "string",
"average_ticket_value": "string",
"highest_amount_to_date": "string",
"sales_percentage": {
"card_swipe_percentage": "string",
"moto_percentage": "string",
"online_percentage": "string",
"keyed_percentage": "string"
},
"average_amex_monthly_sales": "string",
"average_amex_ticket_value": "string"
},
"bank_account_results": "string",
"capabilities": {
"types": [
"two_tiered",
"ach"
],
"options": {
"two_tiered": {
"vmd_cp_rate_percent": "2.00",
"vmd_cp_fee_fixed": "0.10",
"vmd_cnp_rate_percent": "2.50",
"vmd_cnp_fee_fixed": "0.15",
"amex_cp_rate_percent": "3.10",
"amex_cp_fee_fixed": "0.25",
"amex_cnp_rate_percent": "3.50",
"amex_cnp_fee_fixed": "0.30"
},
"ach": {
"txn_fee_percent": "1.50",
"txn_fee_fixed": "0.25"
}
}
},
"fees": {
"monthly": {
"minimum_processing_fee": 35,
"merchant_advance_service_charge": 35
}
}
}'Update merchant data
Enum"Sole Proprietor""Limited Liability (LLC)""Partnership""Association/State & Trust""Tax Exempt Org""Corporation"
Enum"President""Vice President""Treasurer""Owner""Partner""CEO""Secretary""Director""Controller""Accountant"
Ownership percentage as a numeric value between 0 and 100 (without % symbol)
Example: "25"
Enum"Apparel""B2B""Construction""Education""Entertainment""Financial Services""Grocery and Food""Lodging""Medical""Restaurants"
Enum"Veterinary Services""Agricultural Cooperatives""Landscaping Services""Miscellaneous Publishing and Printing Services""Typesetting, Plate Making and Related Services (Business to Business MCC)""Specialty Cleaning, Polishing and Sanitation Preparations (Business to Business MCC)""Equipment Sales""Tailors, Seamstresses, Mending, Alterations""Laundry, Cleaning, and Garment Services""Laundromats"
URL to redirect after completing a transaction
Example: "https://merchant-site.com/thank-you"
Custom domain for merchant onboarding
Example: "https://apply.example.com"
Capability types
Items Enum"two_tiered""pass_through_ic""flat_rate""tiered""cash_discount""ach"
Example: ["two_tiered","ach"]
Visa/Mastercard card present rate percent
Example: "2.00"
Visa/Mastercard card present fee fixed
Example: "0.10"
Visa/Mastercard card not present rate percent
Example: "2.50"
Visa/Mastercard card not present fee fixed
Example: "0.15"
Amex card present rate percent
Example: "3.10"
Amex card present fee fixed
Example: "0.25"
Amex card not present rate percent
Example: "3.50"
Processor markup percent
Example: "0.10"
Transaction fee fixed
Example: "0.10"
Visa/Mastercard credit discount percent
Visa/Mastercard credit fee fixed
Visa/Mastercard debit discount percent
Visa/Mastercard debit fee fixed
Amex discount percent
Flat rate percent
Example: "2.90"
Visa/Mastercard credit rate percent
Visa/Mastercard credit fee fixed
Visa/Mastercard debit rate percent
Visa/Mastercard debit fee fixed
Visa/Mastercard qualified credit rate percent
Example: "1.79"
Visa/Mastercard mid-qualified credit rate percent
Example: "2.19"
Visa/Mastercard mid-qualified credit fee fixed
Example: "0.15"
Visa/Mastercard non-qualified credit rate percent
Example: "3.25"
Visa/Mastercard non-qualified credit fee fixed
Example: "0.20"
Visa/Mastercard qualified debit rate percent
Example: "1.50"
Visa/Mastercard mid-qualified debit rate percent
Example: "1.90"
Visa/Mastercard mid-qualified debit fee fixed
Example: "0.12"
Visa/Mastercard non-qualified debit rate percent
Example: "2.95"
Visa/Mastercard non-qualified debit fee fixed
Example: "0.18"
Amex qualified credit rate percent
Example: "2.89"
Amex mid-qualified credit rate percent
Example: "3.29"
Amex mid-qualified credit fee fixed
Example: "0.25"
Amex non-qualified credit rate percent
Example: "4.35"
Amex non-qualified credit fee fixed
Example: "0.30"
Qualified rate percent (legacy)
Example: "1.79"
Qualified fee fixed (legacy)
Example: "0.10"
Mid-qualified rate percent (legacy)
Example: "2.19"
Mid-qualified fee fixed (legacy)
Example: "0.15"
Non-qualified rate percent (legacy)
Example: "3.25"
ACH transaction fixed fee
Example: "0.25"
ACH transaction percentage fee
Example: "0.75"
ACH return fixed fee
Example: "5.00"
ACH chargeback fixed fee
Example: "10.00"
ACH transaction premium fixed fee
Example: "0.30"
ACH daily batch fee
Example: "1.00"
ACH return reversal fee
Example: "7.50"
ACH gross volume discount rate
Example: "2.50"
Response
application/json
{ "id": "merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k", "phone": "12819374192", "automatic_payouts": true, "deactivated": true, "created_at": "2019-08-24T14:15:22Z", "lead_id": 0, "lead_onboarding_status": "NOT_STARTED", "merchant": { "legal_business_name": "string", "legal_phone": "string", "business_phone": "string", "business_type": "Sole Proprietor", "bank_account": { … }, "tin": "string", "tin_type": "EIN", "doing_business_as": "string", "business_established_date": "string", "legal_business_address": { … }, "dba_address": { … }, "owner_one": { … }, "owner_two": { … }, "owner_three": { … }, "owner_four": { … }, "main_product": { … }, "main_contact_person": { … }, "current_sales": { … }, "bank_account_results": "string", "capabilities": { … }, "fees": { … } }, "payment": { "tokenizer_publishable_key": "pub_XXXXXXXXXXXXXX", "terminal_id": "Cx78a65ada9" }, "defaults": { "display_name": "My Store", "logo": "https://example.com/logo.png", "primary_color": "#FF5733", "secondary_color": "#FF5733", "redirect_url": "https://merchant-site.com/thank-you", "custom_domain": "https://apply.example.com", "support": {} }, "default_capabilities": { "types": [ … ], "options": { … } }, "payment_keys": {}, "device": { "id": "dev_2x4y6z8a0b1c2d3e4f5g6h7j8k", "imei": "357111112222333", "imei_status": "ACTIVE", "created_at": "2024-01-15T10:30:00.000Z", "updated_at": "2024-01-15T10:30:00.000Z" } }