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

openapi.json

openapi.yaml

Overview

URL

https://docs.taluspay.com

TalusPay

engineering@taluspay.com

Servers

Mock server

https://docs.taluspay.com/_mock/openapi/

Production environment onboarding

https://api.taluspay.com/

Sandbox environment onboarding

https://api.taluspay-sandbox.com/

Merchants

Operations

Create merchant

Request

Bodyapplication/jsonrequired

phonestringrequired

agentnumber

merchantobject(MerchantDto)

curl -i -X POST \
  -u <username>:<password> \
  https://docs.taluspay.com/_mock/openapi/v1/merchants \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "string",
    "agent": 0,
    "merchant": {
      "legal_business_name": "string",
      "legal_phone": "string",
      "business_phone": "string",
      "business_type": "string",
      "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",
        "last_name": "string",
        "middle_name": "string",
        "job_title": "string",
        "ownership_percentage": "string",
        "email": "string",
        "date_of_birth": "string",
        "home_address": {
          "address": "string",
          "city": "string",
          "state": "string",
          "zip": "string"
        },
        "ssn": "string"
      },
      "owner_two": {
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "job_title": "string",
        "ownership_percentage": "string",
        "email": "string",
        "date_of_birth": "string",
        "home_address": {
          "address": "string",
          "city": "string",
          "state": "string",
          "zip": "string"
        },
        "ssn": "string"
      },
      "owner_three": {
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "job_title": "string",
        "ownership_percentage": "string",
        "email": "string",
        "date_of_birth": "string",
        "home_address": {
          "address": "string",
          "city": "string",
          "state": "string",
          "zip": "string"
        },
        "ssn": "string"
      },
      "owner_four": {
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "job_title": "string",
        "ownership_percentage": "string",
        "email": "string",
        "date_of_birth": "string",
        "home_address": {
          "address": "string",
          "city": "string",
          "state": "string",
          "zip": "string"
        },
        "ssn": "string"
      },
      "main_product": {
        "description": "string",
        "category": "string",
        "subcategory": "string",
        "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"
          }
        }
      }
    }
  }'

Responses

Create merchant, it merchant exists for given phone number it will return the same merchant

Bodyapplication/json

idstringrequired

Example: "merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k"

phonestringrequired

Example: "12819374192"

automatic_payoutsbooleanrequired

Merchant payouts status

deactivatedbooleanrequired

Merchant deactivation flag

created_atstring(date-time)required

lead_idnumberrequired

Onboarding application ID

lead_onboarding_statusstringrequired

Merchant onboarding status

Enum"NOT_STARTED""IN_PROGRESS""COMPLETED""APPROVED""FAILED"

merchantobjectrequired

Merchant onboarding information

merchant.legal_business_namestringrequired

merchant.legal_phonestringrequired

merchant.business_phonestring

merchant.business_typestringrequired

merchant.bank_accountobject(BankAccount)required

merchant.bank_account.bank_namestringrequired

merchant.bank_account.routing_numberstringrequired

merchant.bank_account.account_holder_namestringrequired

merchant.bank_account.account_numberstringrequired

merchant.bank_account.account_number_confirmstringrequired

merchant.tinstringrequired

merchant.tin_typestringrequired

Enum"EIN""SSN""ITIN"

merchant.doing_business_asstring

merchant.business_established_datestringrequired

merchant.legal_business_addressobject(Address)required

merchant.legal_business_address.addressstringrequired

merchant.legal_business_address.citystringrequired

merchant.legal_business_address.statestringrequired

merchant.legal_business_address.zipstringrequired

merchant.dba_addressobject(Address)

merchant.owner_oneobject(Owner)required

merchant.owner_one.first_namestringrequired

merchant.owner_one.last_namestringrequired

merchant.owner_one.middle_namestring

merchant.owner_one.job_titlestringrequired

merchant.owner_one.ownership_percentagestringrequired

merchant.owner_one.emailstringrequired

merchant.owner_one.date_of_birthstringrequired

merchant.owner_one.home_addressobject(Address)required

merchant.owner_one.home_address.addressstringrequired

merchant.owner_one.home_address.citystringrequired

merchant.owner_one.home_address.statestringrequired

merchant.owner_one.home_address.zipstringrequired

merchant.owner_one.ssnstringrequired

merchant.owner_twoobject(Owner)

merchant.owner_threeobject(Owner)

merchant.owner_fourobject(Owner)

merchant.main_productobject(Product)required

merchant.main_product.descriptionstringrequired

merchant.main_product.categorystringrequired

merchant.main_product.subcategorystringrequired

merchant.main_product.websitestringrequired

merchant.main_contact_personobject(MainContactPerson)required

merchant.main_contact_person.namestringrequired

merchant.main_contact_person.emailstringrequired

merchant.current_salesobject(Sales)required

merchant.current_sales.average_monthly_in_credit_cardstringrequired

merchant.current_sales.average_ticket_valuestringrequired

merchant.current_sales.highest_amount_to_datestringrequired

merchant.current_sales.sales_percentageobject(SalesPercentage)required

merchant.current_sales.sales_percentage.card_swipe_percentagestringrequired

merchant.current_sales.sales_percentage.moto_percentagestringrequired

merchant.current_sales.sales_percentage.online_percentagestringrequired

merchant.current_sales.sales_percentage.keyed_percentagestringrequired

merchant.current_sales.average_amex_monthly_salesstringrequired

merchant.current_sales.average_amex_ticket_valuestringrequired

merchant.bank_account_resultsstring

merchant.capabilitiesobject

Capabilities settings

paymentobjectrequired

Merchant payment information

payment.tokenizer_publishable_keystringrequired

Public key used for tokenizer

Example: "pub_XXXXXXXXXXXXXX"

payment.terminal_idstringrequired

Terminal ID

Example: "Cx78a65ada9"

defaultsobjectrequired

Merchant default settings

defaults.displayNamestringrequired

Display name for the merchant

Example: "My Store"

defaults.logostringrequired

Logo URL for the merchant

Example: "https://example.com/logo.png"

defaults.primaryColorstringrequired

Primary color for merchant branding

Example: "#FF5733"

defaults.secondaryColorstringrequired

Secondary color for merchant branding

Example: "#FF5733"

defaults.redirectUrlstring

URL to redirect after completing a transaction

Example: "https://merchant-site.com/thank-you"

defaults.customDomainstring

Custom domain for merchant onboarding

Example: "https://apply.example.com"

default_capabilitiesobjectrequired

Account default capabilities

default_capabilities.typesArray of stringsrequired

Capability types

Items Enum"two_tiered""pass_through_ic""flat_rate""tiered""cash_discount""ach"

Example: ["two_tiered","ach"]

default_capabilities.optionsobjectrequired

Capability options

default_capabilities.options.two_tieredobjectrequired

Two-tiered payment capabilities

default_capabilities.options.two_tiered.vmd_cp_rate_percentstringrequired

Visa/Mastercard card present rate percent

Example: "2.00"

default_capabilities.options.two_tiered.vmd_cp_fee_fixedstringrequired

Visa/Mastercard card present fee fixed

Example: "0.10"

default_capabilities.options.two_tiered.vmd_cnp_rate_percentstringrequired

Visa/Mastercard card not present rate percent

Example: "2.50"

default_capabilities.options.two_tiered.vmd_cnp_fee_fixedstringrequired

Visa/Mastercard card not present fee fixed

Example: "0.15"

default_capabilities.options.two_tiered.amex_cp_rate_percentstringrequired

Amex card present rate percent

Example: "3.10"

default_capabilities.options.two_tiered.amex_cp_fee_fixedstringrequired

Amex card present fee fixed

Example: "0.25"

default_capabilities.options.two_tiered.amex_cnp_rate_percentstringrequired

Amex card not present rate percent

Example: "3.50"

default_capabilities.options.two_tiered.amex_cnp_fee_fixedstringrequired

Amex card not present fee fixed

Example: "0.30"

default_capabilities.options.pass_through_icobjectrequired

Pass-through IC payment capabilities

default_capabilities.options.pass_through_ic.processor_markup_percentstringrequired

Processor markup percent

Example: "0.10"

default_capabilities.options.pass_through_ic.transaction_fee_fixedstringrequired

Transaction fee fixed

Example: "0.10"

default_capabilities.options.pass_through_ic.vmd_credit_discount_percentstringrequired

Visa/Mastercard credit discount percent

default_capabilities.options.pass_through_ic.vmd_credit_fee_fixedstringrequired

Visa/Mastercard credit fee fixed

default_capabilities.options.pass_through_ic.vmd_debit_discount_percentstringrequired

Visa/Mastercard debit discount percent

default_capabilities.options.pass_through_ic.vmd_debit_fee_fixedstringrequired

Visa/Mastercard debit fee fixed

default_capabilities.options.pass_through_ic.amex_discount_percentstringrequired

Amex discount percent

default_capabilities.options.pass_through_ic.amex_fee_fixedstringrequired

Amex fee fixed

default_capabilities.options.flat_rateobjectrequired

Flat rate payment capabilities

default_capabilities.options.flat_rate.rate_percentstringrequired

Flat rate percent

Example: "2.90"

default_capabilities.options.flat_rate.fee_fixedstringrequired

Fee fixed

Example: "0.30"

default_capabilities.options.flat_rate.vmd_credit_rate_percentstringrequired

Visa/Mastercard credit rate percent

default_capabilities.options.flat_rate.vmd_credit_fee_fixedstringrequired

Visa/Mastercard credit fee fixed

default_capabilities.options.flat_rate.vmd_debit_rate_percentstringrequired

Visa/Mastercard debit rate percent

default_capabilities.options.flat_rate.vmd_debit_fee_fixedstringrequired

Visa/Mastercard debit fee fixed

default_capabilities.options.flat_rate.amex_rate_percentstringrequired

Amex rate percent

default_capabilities.options.flat_rate.amex_fee_fixedstringrequired

Amex fee fixed

default_capabilities.options.tieredobjectrequired

Tiered payment capabilities

default_capabilities.options.tiered.vmd_qual_credit_rate_percentstringrequired

Visa/Mastercard qualified credit rate percent

Example: "1.79"

default_capabilities.options.tiered.vmd_midq_credit_rate_percentstringrequired

Visa/Mastercard mid-qualified credit rate percent

Example: "2.19"

default_capabilities.options.tiered.vmd_midq_credit_fee_fixedstringrequired

Visa/Mastercard mid-qualified credit fee fixed

Example: "0.15"

default_capabilities.options.tiered.vmd_nonq_credit_rate_percentstringrequired

Visa/Mastercard non-qualified credit rate percent

Example: "3.25"

default_capabilities.options.tiered.vmd_nonq_credit_fee_fixedstringrequired

Visa/Mastercard non-qualified credit fee fixed

Example: "0.20"

default_capabilities.options.tiered.vmd_qual_debit_rate_percentstringrequired

Visa/Mastercard qualified debit rate percent

Example: "1.50"

default_capabilities.options.tiered.vmd_midq_debit_rate_percentstringrequired

Visa/Mastercard mid-qualified debit rate percent

Example: "1.90"

default_capabilities.options.tiered.vmd_midq_debit_fee_fixedstringrequired

Visa/Mastercard mid-qualified debit fee fixed

Example: "0.12"

default_capabilities.options.tiered.vmd_nonq_debit_rate_percentstringrequired

Visa/Mastercard non-qualified debit rate percent

Example: "2.95"

default_capabilities.options.tiered.vmd_nonq_debit_fee_fixedstringrequired

Visa/Mastercard non-qualified debit fee fixed

Example: "0.18"

default_capabilities.options.tiered.amex_qual_credit_rate_percentstringrequired

Amex qualified credit rate percent

Example: "2.89"

default_capabilities.options.tiered.amex_midq_credit_rate_percentstringrequired

Amex mid-qualified credit rate percent

Example: "3.29"

default_capabilities.options.tiered.amex_midq_credit_fee_fixedstringrequired

Amex mid-qualified credit fee fixed

Example: "0.25"

default_capabilities.options.tiered.amex_nonq_credit_rate_percentstringrequired

Amex non-qualified credit rate percent

Example: "4.35"

default_capabilities.options.tiered.amex_nonq_credit_fee_fixedstringrequired

Amex non-qualified credit fee fixed

Example: "0.30"

default_capabilities.options.tiered.qualified_rate_percentstringrequired

Qualified rate percent (legacy)

Example: "1.79"

default_capabilities.options.tiered.qualified_fee_fixedstringrequired

Qualified fee fixed (legacy)

Example: "0.10"

default_capabilities.options.tiered.mid_qualified_rate_percentstringrequired

Mid-qualified rate percent (legacy)

Example: "2.19"

default_capabilities.options.tiered.mid_qualified_fee_fixedstringrequired

Mid-qualified fee fixed (legacy)

Example: "0.15"

default_capabilities.options.tiered.non_qualified_rate_percentstringrequired

Non-qualified rate percent (legacy)

Example: "3.25"

default_capabilities.options.tiered.non_qualified_fee_fixedstringrequired

Non-qualified fee fixed (legacy)

Example: "0.20"

default_capabilities.options.cash_discountobjectrequired

Cash discount payment capabilities

default_capabilities.options.cash_discount.enabledbooleanrequired

Is cash discount enabled

Example: true

default_capabilities.options.achobjectrequired

ACH payment capabilities

default_capabilities.options.ach.txn_fee_fixedstringrequired

ACH transaction fixed fee

Example: "0.25"

default_capabilities.options.ach.txn_fee_percentstringrequired

ACH transaction percentage fee

Example: "0.75"

default_capabilities.options.ach.return_fee_fixedstringrequired

ACH return fixed fee

Example: "5.00"

default_capabilities.options.ach.chargeback_fee_fixedstringrequired

ACH chargeback fixed fee

Example: "10.00"

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": "string",
    "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": { … }
  },
  "payment": {
    "tokenizer_publishable_key": "pub_XXXXXXXXXXXXXX",
    "terminal_id": "Cx78a65ada9"
  },
  "defaults": {
    "displayName": "My Store",
    "logo": "https://example.com/logo.png",
    "primaryColor": "#FF5733",
    "secondaryColor": "#FF5733",
    "redirectUrl": "https://merchant-site.com/thank-you",
    "customDomain": "https://apply.example.com"
  },
  "default_capabilities": {
    "types": [ … ],
    "options": { … }
  }
}

Get merchant

Request

Path

merchant_idstringrequired

curl -i -X GET \
  -u <username>:<password> \
  'https://docs.taluspay.com/_mock/openapi/v1/merchants/{merchant_id}'

Responses

Get merchant object

Bodyapplication/json

idstringrequired

Example: "merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k"

phonestringrequired

Example: "12819374192"

automatic_payoutsbooleanrequired

Merchant payouts status

deactivatedbooleanrequired

Merchant deactivation flag

created_atstring(date-time)required

lead_idnumberrequired

Onboarding application ID

lead_onboarding_statusstringrequired

Merchant onboarding status

Enum"NOT_STARTED""IN_PROGRESS""COMPLETED""APPROVED""FAILED"

merchantobjectrequired

Merchant onboarding information

merchant.legal_business_namestringrequired

merchant.legal_phonestringrequired

merchant.business_phonestring

merchant.business_typestringrequired

merchant.bank_accountobject(BankAccount)required

merchant.bank_account.bank_namestringrequired

merchant.bank_account.routing_numberstringrequired

merchant.bank_account.account_holder_namestringrequired

merchant.bank_account.account_numberstringrequired

merchant.bank_account.account_number_confirmstringrequired

merchant.tinstringrequired

merchant.tin_typestringrequired

Enum"EIN""SSN""ITIN"

merchant.doing_business_asstring

merchant.business_established_datestringrequired

merchant.legal_business_addressobject(Address)required

merchant.legal_business_address.addressstringrequired

merchant.legal_business_address.citystringrequired

merchant.legal_business_address.statestringrequired

merchant.legal_business_address.zipstringrequired

merchant.dba_addressobject(Address)

merchant.owner_oneobject(Owner)required

merchant.owner_one.first_namestringrequired

merchant.owner_one.last_namestringrequired

merchant.owner_one.middle_namestring

merchant.owner_one.job_titlestringrequired

merchant.owner_one.ownership_percentagestringrequired

merchant.owner_one.emailstringrequired

merchant.owner_one.date_of_birthstringrequired

merchant.owner_one.home_addressobject(Address)required

merchant.owner_one.home_address.addressstringrequired

merchant.owner_one.home_address.citystringrequired

merchant.owner_one.home_address.statestringrequired

merchant.owner_one.home_address.zipstringrequired

merchant.owner_one.ssnstringrequired

merchant.owner_twoobject(Owner)

merchant.owner_threeobject(Owner)

merchant.owner_fourobject(Owner)

merchant.main_productobject(Product)required

merchant.main_product.descriptionstringrequired

merchant.main_product.categorystringrequired

merchant.main_product.subcategorystringrequired

merchant.main_product.websitestringrequired

merchant.main_contact_personobject(MainContactPerson)required

merchant.main_contact_person.namestringrequired

merchant.main_contact_person.emailstringrequired

merchant.current_salesobject(Sales)required

merchant.current_sales.average_monthly_in_credit_cardstringrequired

merchant.current_sales.average_ticket_valuestringrequired

merchant.current_sales.highest_amount_to_datestringrequired

merchant.current_sales.sales_percentageobject(SalesPercentage)required

merchant.current_sales.sales_percentage.card_swipe_percentagestringrequired

merchant.current_sales.sales_percentage.moto_percentagestringrequired

merchant.current_sales.sales_percentage.online_percentagestringrequired

merchant.current_sales.sales_percentage.keyed_percentagestringrequired

merchant.current_sales.average_amex_monthly_salesstringrequired

merchant.current_sales.average_amex_ticket_valuestringrequired

merchant.bank_account_resultsstring

merchant.capabilitiesobject

Capabilities settings

paymentobjectrequired

Merchant payment information

payment.tokenizer_publishable_keystringrequired

Public key used for tokenizer

Example: "pub_XXXXXXXXXXXXXX"

payment.terminal_idstringrequired

Terminal ID

Example: "Cx78a65ada9"

defaultsobjectrequired

Merchant default settings

defaults.displayNamestringrequired

Display name for the merchant

Example: "My Store"

defaults.logostringrequired

Logo URL for the merchant

Example: "https://example.com/logo.png"

defaults.primaryColorstringrequired

Primary color for merchant branding

Example: "#FF5733"

defaults.secondaryColorstringrequired

Secondary color for merchant branding

Example: "#FF5733"

defaults.redirectUrlstring

URL to redirect after completing a transaction

Example: "https://merchant-site.com/thank-you"

defaults.customDomainstring

Custom domain for merchant onboarding

Example: "https://apply.example.com"

default_capabilitiesobjectrequired

Account default capabilities

default_capabilities.typesArray of stringsrequired

Capability types

Items Enum"two_tiered""pass_through_ic""flat_rate""tiered""cash_discount""ach"

Example: ["two_tiered","ach"]

default_capabilities.optionsobjectrequired

Capability options

default_capabilities.options.two_tieredobjectrequired

Two-tiered payment capabilities

default_capabilities.options.two_tiered.vmd_cp_rate_percentstringrequired

Visa/Mastercard card present rate percent

Example: "2.00"

default_capabilities.options.two_tiered.vmd_cp_fee_fixedstringrequired

Visa/Mastercard card present fee fixed

Example: "0.10"

default_capabilities.options.two_tiered.vmd_cnp_rate_percentstringrequired

Visa/Mastercard card not present rate percent

Example: "2.50"

default_capabilities.options.two_tiered.vmd_cnp_fee_fixedstringrequired

Visa/Mastercard card not present fee fixed

Example: "0.15"

default_capabilities.options.two_tiered.amex_cp_rate_percentstringrequired

Amex card present rate percent

Example: "3.10"

default_capabilities.options.two_tiered.amex_cp_fee_fixedstringrequired

Amex card present fee fixed

Example: "0.25"

default_capabilities.options.two_tiered.amex_cnp_rate_percentstringrequired

Amex card not present rate percent

Example: "3.50"

default_capabilities.options.two_tiered.amex_cnp_fee_fixedstringrequired

Amex card not present fee fixed

Example: "0.30"

default_capabilities.options.pass_through_icobjectrequired

Pass-through IC payment capabilities

default_capabilities.options.pass_through_ic.processor_markup_percentstringrequired

Processor markup percent

Example: "0.10"

default_capabilities.options.pass_through_ic.transaction_fee_fixedstringrequired

Transaction fee fixed

Example: "0.10"

default_capabilities.options.pass_through_ic.vmd_credit_discount_percentstringrequired

Visa/Mastercard credit discount percent

default_capabilities.options.pass_through_ic.vmd_credit_fee_fixedstringrequired

Visa/Mastercard credit fee fixed

default_capabilities.options.pass_through_ic.vmd_debit_discount_percentstringrequired

Visa/Mastercard debit discount percent

default_capabilities.options.pass_through_ic.vmd_debit_fee_fixedstringrequired

Visa/Mastercard debit fee fixed

default_capabilities.options.pass_through_ic.amex_discount_percentstringrequired

Amex discount percent

default_capabilities.options.pass_through_ic.amex_fee_fixedstringrequired

Amex fee fixed

default_capabilities.options.flat_rateobjectrequired

Flat rate payment capabilities

default_capabilities.options.flat_rate.rate_percentstringrequired

Flat rate percent

Example: "2.90"

default_capabilities.options.flat_rate.fee_fixedstringrequired

Fee fixed

Example: "0.30"

default_capabilities.options.flat_rate.vmd_credit_rate_percentstringrequired

Visa/Mastercard credit rate percent

default_capabilities.options.flat_rate.vmd_credit_fee_fixedstringrequired

Visa/Mastercard credit fee fixed

default_capabilities.options.flat_rate.vmd_debit_rate_percentstringrequired

Visa/Mastercard debit rate percent

default_capabilities.options.flat_rate.vmd_debit_fee_fixedstringrequired

Visa/Mastercard debit fee fixed

default_capabilities.options.flat_rate.amex_rate_percentstringrequired

Amex rate percent

default_capabilities.options.flat_rate.amex_fee_fixedstringrequired

Amex fee fixed

default_capabilities.options.tieredobjectrequired

Tiered payment capabilities

default_capabilities.options.tiered.vmd_qual_credit_rate_percentstringrequired

Visa/Mastercard qualified credit rate percent

Example: "1.79"

default_capabilities.options.tiered.vmd_midq_credit_rate_percentstringrequired

Visa/Mastercard mid-qualified credit rate percent

Example: "2.19"

default_capabilities.options.tiered.vmd_midq_credit_fee_fixedstringrequired

Visa/Mastercard mid-qualified credit fee fixed

Example: "0.15"

default_capabilities.options.tiered.vmd_nonq_credit_rate_percentstringrequired

Visa/Mastercard non-qualified credit rate percent

Example: "3.25"

default_capabilities.options.tiered.vmd_nonq_credit_fee_fixedstringrequired

Visa/Mastercard non-qualified credit fee fixed

Example: "0.20"

default_capabilities.options.tiered.vmd_qual_debit_rate_percentstringrequired

Visa/Mastercard qualified debit rate percent

Example: "1.50"

default_capabilities.options.tiered.vmd_midq_debit_rate_percentstringrequired

Visa/Mastercard mid-qualified debit rate percent

Example: "1.90"

default_capabilities.options.tiered.vmd_midq_debit_fee_fixedstringrequired

Visa/Mastercard mid-qualified debit fee fixed

Example: "0.12"

default_capabilities.options.tiered.vmd_nonq_debit_rate_percentstringrequired

Visa/Mastercard non-qualified debit rate percent

Example: "2.95"

default_capabilities.options.tiered.vmd_nonq_debit_fee_fixedstringrequired

Visa/Mastercard non-qualified debit fee fixed

Example: "0.18"

default_capabilities.options.tiered.amex_qual_credit_rate_percentstringrequired

Amex qualified credit rate percent

Example: "2.89"

default_capabilities.options.tiered.amex_midq_credit_rate_percentstringrequired

Amex mid-qualified credit rate percent

Example: "3.29"

default_capabilities.options.tiered.amex_midq_credit_fee_fixedstringrequired

Amex mid-qualified credit fee fixed

Example: "0.25"

default_capabilities.options.tiered.amex_nonq_credit_rate_percentstringrequired

Amex non-qualified credit rate percent

Example: "4.35"

default_capabilities.options.tiered.amex_nonq_credit_fee_fixedstringrequired

Amex non-qualified credit fee fixed

Example: "0.30"

default_capabilities.options.tiered.qualified_rate_percentstringrequired

Qualified rate percent (legacy)

Example: "1.79"

default_capabilities.options.tiered.qualified_fee_fixedstringrequired

Qualified fee fixed (legacy)

Example: "0.10"

default_capabilities.options.tiered.mid_qualified_rate_percentstringrequired

Mid-qualified rate percent (legacy)

Example: "2.19"

default_capabilities.options.tiered.mid_qualified_fee_fixedstringrequired

Mid-qualified fee fixed (legacy)

Example: "0.15"

default_capabilities.options.tiered.non_qualified_rate_percentstringrequired

Non-qualified rate percent (legacy)

Example: "3.25"

default_capabilities.options.tiered.non_qualified_fee_fixedstringrequired

Non-qualified fee fixed (legacy)

Example: "0.20"

default_capabilities.options.cash_discountobjectrequired

Cash discount payment capabilities

default_capabilities.options.cash_discount.enabledbooleanrequired

Is cash discount enabled

Example: true

default_capabilities.options.achobjectrequired

ACH payment capabilities

default_capabilities.options.ach.txn_fee_fixedstringrequired

ACH transaction fixed fee

Example: "0.25"

default_capabilities.options.ach.txn_fee_percentstringrequired

ACH transaction percentage fee

Example: "0.75"

default_capabilities.options.ach.return_fee_fixedstringrequired

ACH return fixed fee

Example: "5.00"

default_capabilities.options.ach.chargeback_fee_fixedstringrequired

ACH chargeback fixed fee

Example: "10.00"

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": "string",
    "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": { … }
  },
  "payment": {
    "tokenizer_publishable_key": "pub_XXXXXXXXXXXXXX",
    "terminal_id": "Cx78a65ada9"
  },
  "defaults": {
    "displayName": "My Store",
    "logo": "https://example.com/logo.png",
    "primaryColor": "#FF5733",
    "secondaryColor": "#FF5733",
    "redirectUrl": "https://merchant-site.com/thank-you",
    "customDomain": "https://apply.example.com"
  },
  "default_capabilities": {
    "types": [ … ],
    "options": { … }
  }
}

Update merchant

Request

Path

merchant_idstringrequired

Bodyapplication/jsonrequired

legal_business_namestringrequired

legal_phonestringrequired

business_phonestring

business_typestringrequired

bank_accountobject(BankAccount)required

bank_account.bank_namestringrequired

bank_account.routing_numberstringrequired

bank_account.account_holder_namestringrequired

bank_account.account_numberstringrequired

bank_account.account_number_confirmstringrequired

tinstringrequired

tin_typestringrequired

Enum"EIN""SSN""ITIN"

doing_business_asstring

business_established_datestringrequired

legal_business_addressobject(Address)required

legal_business_address.addressstringrequired

legal_business_address.citystringrequired

legal_business_address.statestringrequired

legal_business_address.zipstringrequired

dba_addressobject(Address)

owner_oneobject(Owner)required

owner_one.first_namestringrequired

owner_one.last_namestringrequired

owner_one.middle_namestring

owner_one.job_titlestringrequired

owner_one.ownership_percentagestringrequired

owner_one.emailstringrequired

owner_one.date_of_birthstringrequired

owner_one.home_addressobject(Address)required

owner_one.home_address.addressstringrequired

owner_one.home_address.citystringrequired

owner_one.home_address.statestringrequired

owner_one.home_address.zipstringrequired

owner_one.ssnstringrequired

owner_twoobject(Owner)

owner_threeobject(Owner)

owner_fourobject(Owner)

main_productobject(Product)required

main_product.descriptionstringrequired

main_product.categorystringrequired

main_product.subcategorystringrequired

main_product.websitestringrequired

main_contact_personobject(MainContactPerson)required

main_contact_person.namestringrequired

main_contact_person.emailstringrequired

current_salesobject(Sales)required

current_sales.average_monthly_in_credit_cardstringrequired

current_sales.average_ticket_valuestringrequired

current_sales.highest_amount_to_datestringrequired

current_sales.sales_percentageobject(SalesPercentage)required

current_sales.sales_percentage.card_swipe_percentagestringrequired

current_sales.sales_percentage.moto_percentagestringrequired

current_sales.sales_percentage.online_percentagestringrequired

current_sales.sales_percentage.keyed_percentagestringrequired

current_sales.average_amex_monthly_salesstringrequired

current_sales.average_amex_ticket_valuestringrequired

bank_account_resultsstring

capabilitiesobject

Capabilities settings

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": "string",
    "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",
      "last_name": "string",
      "middle_name": "string",
      "job_title": "string",
      "ownership_percentage": "string",
      "email": "string",
      "date_of_birth": "string",
      "home_address": {
        "address": "string",
        "city": "string",
        "state": "string",
        "zip": "string"
      },
      "ssn": "string"
    },
    "owner_two": {
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string",
      "job_title": "string",
      "ownership_percentage": "string",
      "email": "string",
      "date_of_birth": "string",
      "home_address": {
        "address": "string",
        "city": "string",
        "state": "string",
        "zip": "string"
      },
      "ssn": "string"
    },
    "owner_three": {
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string",
      "job_title": "string",
      "ownership_percentage": "string",
      "email": "string",
      "date_of_birth": "string",
      "home_address": {
        "address": "string",
        "city": "string",
        "state": "string",
        "zip": "string"
      },
      "ssn": "string"
    },
    "owner_four": {
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string",
      "job_title": "string",
      "ownership_percentage": "string",
      "email": "string",
      "date_of_birth": "string",
      "home_address": {
        "address": "string",
        "city": "string",
        "state": "string",
        "zip": "string"
      },
      "ssn": "string"
    },
    "main_product": {
      "description": "string",
      "category": "string",
      "subcategory": "string",
      "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"
        }
      }
    }
  }'

Responses

Update merchant lead data

Bodyapplication/json

idstringrequired

Example: "merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k"

phonestringrequired

Example: "12819374192"

automatic_payoutsbooleanrequired

Merchant payouts status

deactivatedbooleanrequired

Merchant deactivation flag

created_atstring(date-time)required

lead_idnumberrequired

Onboarding application ID

lead_onboarding_statusstringrequired

Merchant onboarding status

Enum"NOT_STARTED""IN_PROGRESS""COMPLETED""APPROVED""FAILED"

merchantobjectrequired

Merchant onboarding information

merchant.legal_business_namestringrequired

merchant.legal_phonestringrequired

merchant.business_phonestring

merchant.business_typestringrequired

merchant.bank_accountobject(BankAccount)required

merchant.bank_account.bank_namestringrequired

merchant.bank_account.routing_numberstringrequired

merchant.bank_account.account_holder_namestringrequired

merchant.bank_account.account_numberstringrequired

merchant.bank_account.account_number_confirmstringrequired

merchant.tinstringrequired

merchant.tin_typestringrequired

Enum"EIN""SSN""ITIN"

merchant.doing_business_asstring

merchant.business_established_datestringrequired

merchant.legal_business_addressobject(Address)required

merchant.legal_business_address.addressstringrequired

merchant.legal_business_address.citystringrequired

merchant.legal_business_address.statestringrequired

merchant.legal_business_address.zipstringrequired

merchant.dba_addressobject(Address)

merchant.owner_oneobject(Owner)required

merchant.owner_one.first_namestringrequired

merchant.owner_one.last_namestringrequired

merchant.owner_one.middle_namestring

merchant.owner_one.job_titlestringrequired

merchant.owner_one.ownership_percentagestringrequired

merchant.owner_one.emailstringrequired

merchant.owner_one.date_of_birthstringrequired

merchant.owner_one.home_addressobject(Address)required

merchant.owner_one.home_address.addressstringrequired

merchant.owner_one.home_address.citystringrequired

merchant.owner_one.home_address.statestringrequired

merchant.owner_one.home_address.zipstringrequired

merchant.owner_one.ssnstringrequired

merchant.owner_twoobject(Owner)

merchant.owner_threeobject(Owner)

merchant.owner_fourobject(Owner)

merchant.main_productobject(Product)required

merchant.main_product.descriptionstringrequired

merchant.main_product.categorystringrequired

merchant.main_product.subcategorystringrequired

merchant.main_product.websitestringrequired

merchant.main_contact_personobject(MainContactPerson)required

merchant.main_contact_person.namestringrequired

merchant.main_contact_person.emailstringrequired

merchant.current_salesobject(Sales)required

merchant.current_sales.average_monthly_in_credit_cardstringrequired

merchant.current_sales.average_ticket_valuestringrequired

merchant.current_sales.highest_amount_to_datestringrequired

merchant.current_sales.sales_percentageobject(SalesPercentage)required

merchant.current_sales.sales_percentage.card_swipe_percentagestringrequired

merchant.current_sales.sales_percentage.moto_percentagestringrequired

merchant.current_sales.sales_percentage.online_percentagestringrequired

merchant.current_sales.sales_percentage.keyed_percentagestringrequired

merchant.current_sales.average_amex_monthly_salesstringrequired

merchant.current_sales.average_amex_ticket_valuestringrequired

merchant.bank_account_resultsstring

merchant.capabilitiesobject

Capabilities settings

paymentobjectrequired

Merchant payment information

payment.tokenizer_publishable_keystringrequired

Public key used for tokenizer

Example: "pub_XXXXXXXXXXXXXX"

payment.terminal_idstringrequired

Terminal ID

Example: "Cx78a65ada9"

defaultsobjectrequired

Merchant default settings

defaults.displayNamestringrequired

Display name for the merchant

Example: "My Store"

defaults.logostringrequired

Logo URL for the merchant

Example: "https://example.com/logo.png"

defaults.primaryColorstringrequired

Primary color for merchant branding

Example: "#FF5733"

defaults.secondaryColorstringrequired

Secondary color for merchant branding

Example: "#FF5733"

defaults.redirectUrlstring

URL to redirect after completing a transaction

Example: "https://merchant-site.com/thank-you"

defaults.customDomainstring

Custom domain for merchant onboarding

Example: "https://apply.example.com"

default_capabilitiesobjectrequired

Account default capabilities

default_capabilities.typesArray of stringsrequired

Capability types

Items Enum"two_tiered""pass_through_ic""flat_rate""tiered""cash_discount""ach"

Example: ["two_tiered","ach"]

default_capabilities.optionsobjectrequired

Capability options

default_capabilities.options.two_tieredobjectrequired

Two-tiered payment capabilities

default_capabilities.options.two_tiered.vmd_cp_rate_percentstringrequired

Visa/Mastercard card present rate percent

Example: "2.00"

default_capabilities.options.two_tiered.vmd_cp_fee_fixedstringrequired

Visa/Mastercard card present fee fixed

Example: "0.10"

default_capabilities.options.two_tiered.vmd_cnp_rate_percentstringrequired

Visa/Mastercard card not present rate percent

Example: "2.50"

default_capabilities.options.two_tiered.vmd_cnp_fee_fixedstringrequired

Visa/Mastercard card not present fee fixed

Example: "0.15"

default_capabilities.options.two_tiered.amex_cp_rate_percentstringrequired

Amex card present rate percent

Example: "3.10"

default_capabilities.options.two_tiered.amex_cp_fee_fixedstringrequired

Amex card present fee fixed

Example: "0.25"

default_capabilities.options.two_tiered.amex_cnp_rate_percentstringrequired

Amex card not present rate percent

Example: "3.50"

default_capabilities.options.two_tiered.amex_cnp_fee_fixedstringrequired

Amex card not present fee fixed

Example: "0.30"

default_capabilities.options.pass_through_icobjectrequired

Pass-through IC payment capabilities

default_capabilities.options.pass_through_ic.processor_markup_percentstringrequired

Processor markup percent

Example: "0.10"

default_capabilities.options.pass_through_ic.transaction_fee_fixedstringrequired

Transaction fee fixed

Example: "0.10"

default_capabilities.options.pass_through_ic.vmd_credit_discount_percentstringrequired

Visa/Mastercard credit discount percent

default_capabilities.options.pass_through_ic.vmd_credit_fee_fixedstringrequired

Visa/Mastercard credit fee fixed

default_capabilities.options.pass_through_ic.vmd_debit_discount_percentstringrequired

Visa/Mastercard debit discount percent

default_capabilities.options.pass_through_ic.vmd_debit_fee_fixedstringrequired

Visa/Mastercard debit fee fixed

default_capabilities.options.pass_through_ic.amex_discount_percentstringrequired

Amex discount percent

default_capabilities.options.pass_through_ic.amex_fee_fixedstringrequired

Amex fee fixed

default_capabilities.options.flat_rateobjectrequired

Flat rate payment capabilities

default_capabilities.options.flat_rate.rate_percentstringrequired

Flat rate percent

Example: "2.90"

default_capabilities.options.flat_rate.fee_fixedstringrequired

Fee fixed

Example: "0.30"

default_capabilities.options.flat_rate.vmd_credit_rate_percentstringrequired

Visa/Mastercard credit rate percent

default_capabilities.options.flat_rate.vmd_credit_fee_fixedstringrequired

Visa/Mastercard credit fee fixed

default_capabilities.options.flat_rate.vmd_debit_rate_percentstringrequired

Visa/Mastercard debit rate percent

default_capabilities.options.flat_rate.vmd_debit_fee_fixedstringrequired

Visa/Mastercard debit fee fixed

default_capabilities.options.flat_rate.amex_rate_percentstringrequired

Amex rate percent

default_capabilities.options.flat_rate.amex_fee_fixedstringrequired

Amex fee fixed

default_capabilities.options.tieredobjectrequired

Tiered payment capabilities

default_capabilities.options.tiered.vmd_qual_credit_rate_percentstringrequired

Visa/Mastercard qualified credit rate percent

Example: "1.79"

default_capabilities.options.tiered.vmd_midq_credit_rate_percentstringrequired

Visa/Mastercard mid-qualified credit rate percent

Example: "2.19"

default_capabilities.options.tiered.vmd_midq_credit_fee_fixedstringrequired

Visa/Mastercard mid-qualified credit fee fixed

Example: "0.15"

default_capabilities.options.tiered.vmd_nonq_credit_rate_percentstringrequired

Visa/Mastercard non-qualified credit rate percent

Example: "3.25"

default_capabilities.options.tiered.vmd_nonq_credit_fee_fixedstringrequired

Visa/Mastercard non-qualified credit fee fixed

Example: "0.20"

default_capabilities.options.tiered.vmd_qual_debit_rate_percentstringrequired

Visa/Mastercard qualified debit rate percent

Example: "1.50"

default_capabilities.options.tiered.vmd_midq_debit_rate_percentstringrequired

Visa/Mastercard mid-qualified debit rate percent

Example: "1.90"

default_capabilities.options.tiered.vmd_midq_debit_fee_fixedstringrequired

Visa/Mastercard mid-qualified debit fee fixed

Example: "0.12"

default_capabilities.options.tiered.vmd_nonq_debit_rate_percentstringrequired

Visa/Mastercard non-qualified debit rate percent

Example: "2.95"

default_capabilities.options.tiered.vmd_nonq_debit_fee_fixedstringrequired

Visa/Mastercard non-qualified debit fee fixed

Example: "0.18"

default_capabilities.options.tiered.amex_qual_credit_rate_percentstringrequired

Amex qualified credit rate percent

Example: "2.89"

default_capabilities.options.tiered.amex_midq_credit_rate_percentstringrequired

Amex mid-qualified credit rate percent

Example: "3.29"

default_capabilities.options.tiered.amex_midq_credit_fee_fixedstringrequired

Amex mid-qualified credit fee fixed

Example: "0.25"

default_capabilities.options.tiered.amex_nonq_credit_rate_percentstringrequired

Amex non-qualified credit rate percent

Example: "4.35"

default_capabilities.options.tiered.amex_nonq_credit_fee_fixedstringrequired

Amex non-qualified credit fee fixed

Example: "0.30"

default_capabilities.options.tiered.qualified_rate_percentstringrequired

Qualified rate percent (legacy)

Example: "1.79"

default_capabilities.options.tiered.qualified_fee_fixedstringrequired

Qualified fee fixed (legacy)

Example: "0.10"

default_capabilities.options.tiered.mid_qualified_rate_percentstringrequired

Mid-qualified rate percent (legacy)

Example: "2.19"

default_capabilities.options.tiered.mid_qualified_fee_fixedstringrequired

Mid-qualified fee fixed (legacy)

Example: "0.15"

default_capabilities.options.tiered.non_qualified_rate_percentstringrequired

Non-qualified rate percent (legacy)

Example: "3.25"

default_capabilities.options.tiered.non_qualified_fee_fixedstringrequired

Non-qualified fee fixed (legacy)

Example: "0.20"

default_capabilities.options.cash_discountobjectrequired

Cash discount payment capabilities

default_capabilities.options.cash_discount.enabledbooleanrequired

Is cash discount enabled

Example: true

default_capabilities.options.achobjectrequired

ACH payment capabilities

default_capabilities.options.ach.txn_fee_fixedstringrequired

ACH transaction fixed fee

Example: "0.25"

default_capabilities.options.ach.txn_fee_percentstringrequired

ACH transaction percentage fee

Example: "0.75"

default_capabilities.options.ach.return_fee_fixedstringrequired

ACH return fixed fee

Example: "5.00"

default_capabilities.options.ach.chargeback_fee_fixedstringrequired

ACH chargeback fixed fee

Example: "10.00"

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": "string",
    "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": { … }
  },
  "payment": {
    "tokenizer_publishable_key": "pub_XXXXXXXXXXXXXX",
    "terminal_id": "Cx78a65ada9"
  },
  "defaults": {
    "displayName": "My Store",
    "logo": "https://example.com/logo.png",
    "primaryColor": "#FF5733",
    "secondaryColor": "#FF5733",
    "redirectUrl": "https://merchant-site.com/thank-you",
    "customDomain": "https://apply.example.com"
  },
  "default_capabilities": {
    "types": [ … ],
    "options": { … }
  }
}

Create Customer

Request

Create a customer for a given merchant

Path

merchant_idstringrequired

Unique identifier for the merchant

Example: merchant_01j8emz8chfxbb2bqmtref8ch7

Bodyapplication/jsonrequired

descriptionstring[ 0 .. 255 ] charactersrequired

Description of the customer

Example: "Test merchant customer"

curl -i -X POST \
  -u <username>:<password> \
  https://docs.taluspay.com/_mock/openapi/v1/merchants/merchant_01j8emz8chfxbb2bqmtref8ch7/customers \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Test merchant customer"
  }'

Responses

Customer created successfully

Bodyapplication/json

idstringrequired

Unique identifier for the created customer

Example: "cust_02c7t70ef3ig396idugupsr99j"

descriptionstring

Some description

Example: "My customer"

Response

application/json

{
  "id": "cust_02c7t70ef3ig396idugupsr99j",
  "description": "My customer"
}

Get Customer Payment Methods

Request

Retrieve payment methods for a given customer

Path

merchant_idstringrequired

Unique identifier for the merchant

Example: merchant_01j8emz8chfxbb2bqmtref8ch7

customer_idstringrequired

Unique identifier for the customer

Example: cust_02c7t70ef3ig396idugupsr99j

curl -i -X GET \
  -u <username>:<password> \
  https://docs.taluspay.com/_mock/openapi/v1/merchants/merchant_01j8emz8chfxbb2bqmtref8ch7/customers/cust_02c7t70ef3ig396idugupsr99j/payment_methods

Responses

Payment methods retrieved successfully

Bodyapplication/jsonArray [

idstringrequired

Unique identifier for the created payment method

Example: "payment_method_04c7h77rf3ig386ilngopty49z"

customer_idstringrequired

Unique identifier for the created customer

Example: "cust_02c7t70ef3ig396idugupsr99j"

payment_methodstringrequired

Details of the payment method

Value"CARD"

created_atinteger(int32)required

Timestamp when the charge was created

Example: 1727875117482

cardobject(PaymentMethodCard)required

Details of the card used for the payment method

card.card_typestring

Details of the card used for the payment method

Example: "VISA"

card.card_fingerprintstring

Details of the card's fingerprint

Example: "8411d8248f977bce15fba0f495474e4099j15bb9318fda8f0e700a4ad83b7836"

card.card_fundingstring

Details of the card's funding

Example: "debit"

card.masked_numberstring

Masked card number

Example: "400934******1881"

card.expiration_datestring

Expiration date of the card

Example: "01/27"

]

Response

application/json

[
  {
    "id": "payment_method_04c7h77rf3ig386ilngopty49z",
    "customer_id": "cust_02c7t70ef3ig396idugupsr99j",
    "payment_method": "CARD",
    "created_at": 1727875117482,
    "card": { … }
  }
]

Create Customer Payment Method

Request

Create a payment method for a given customer

Path

merchant_idstringrequired

Unique identifier for the merchant

Example: merchant_01j8emz8chfxbb2bqmtref8ch7

customer_idstringrequired

Unique identifier for the customer

Example: cust_02c7t70ef3ig396idugupsr99j

Bodyapplication/jsonrequired

descriptionstring[ 0 .. 255 ] charactersrequired

Description of the payment method

Example: "Test customer"

tokenstringrequired

Token for the payment method

Example: "fxbb2bqmtref8ch7"

curl -i -X POST \
  -u <username>:<password> \
  https://docs.taluspay.com/_mock/openapi/v1/merchants/merchant_01j8emz8chfxbb2bqmtref8ch7/customers/cust_02c7t70ef3ig396idugupsr99j/payment_methods \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Test customer",
    "token": "fxbb2bqmtref8ch7"
  }'

Responses

Payment method created successfully

Bodyapplication/json

idstringrequired

Unique identifier for the created payment method

Example: "payment_method_04c7h77rf3ig386ilngopty49z"

customer_idstringrequired

Unique identifier for the created customer

Example: "cust_02c7t70ef3ig396idugupsr99j"

payment_methodstringrequired

Details of the payment method

Value"CARD"

created_atinteger(int32)required

Timestamp when the charge was created

Example: 1727875117482

cardobject(PaymentMethodCard)required

Details of the card used for the payment method

card.card_typestring

Details of the card used for the payment method

Example: "VISA"

card.card_fingerprintstring

Details of the card's fingerprint

Example: "8411d8248f977bce15fba0f495474e4099j15bb9318fda8f0e700a4ad83b7836"

card.card_fundingstring

Details of the card's funding

Example: "debit"

card.masked_numberstring

Masked card number

Example: "400934******1881"

card.expiration_datestring

Expiration date of the card

Example: "01/27"

Response

application/json

{
  "id": "payment_method_04c7h77rf3ig386ilngopty49z",
  "customer_id": "cust_02c7t70ef3ig396idugupsr99j",
  "payment_method": "CARD",
  "created_at": 1727875117482,
  "card": {
    "card_type": "VISA",
    "card_fingerprint": "8411d8248f977bce15fba0f495474e4099j15bb9318fda8f0e700a4ad83b7836",
    "card_funding": "debit",
    "masked_number": "400934******1881",
    "expiration_date": "01/27"
  }
}

Get Customer Payment Method By Fingerprint

Request

Retrieve payment method for a given fingerprint

Path

merchant_idstringrequired

Unique identifier for the merchant

Example: merchant_01j8emz8chfxbb2bqmtref8ch7

customer_idstringrequired

Unique identifier for the customer

Example: cust_02c7t70ef3ig396idugupsr99j

card_fingerprintstringrequired

Unique identifier for the card fingerprint

Example: 8411d8248f976bcr15fba0f495476i4098d06aa9318fda8f0e700a4ad83b7837

curl -i -X GET \
  -u <username>:<password> \
  https://docs.taluspay.com/_mock/openapi/v1/merchants/merchant_01j8emz8chfxbb2bqmtref8ch7/customers/cust_02c7t70ef3ig396idugupsr99j/payment_methods/8411d8248f976bcr15fba0f495476i4098d06aa9318fda8f0e700a4ad83b7837

Responses

Payment methods retrieved successfully

Bodyapplication/json

idstringrequired

Unique identifier for the created payment method

Example: "payment_method_04c7h77rf3ig386ilngopty49z"

customer_idstringrequired

Unique identifier for the created customer

Example: "cust_02c7t70ef3ig396idugupsr99j"

payment_methodstringrequired

Details of the payment method

Value"CARD"

created_atinteger(int32)required

Timestamp when the charge was created

Example: 1727875117482

cardobject(PaymentMethodCard)required

Details of the card used for the payment method

card.card_typestring

Details of the card used for the payment method

Example: "VISA"

card.card_fingerprintstring

Details of the card's fingerprint

Example: "8411d8248f977bce15fba0f495474e4099j15bb9318fda8f0e700a4ad83b7836"

card.card_fundingstring

Details of the card's funding

Example: "debit"

card.masked_numberstring

Masked card number

Example: "400934******1881"

card.expiration_datestring

Expiration date of the card

Example: "01/27"

Response

application/json

{
  "id": "payment_method_04c7h77rf3ig386ilngopty49z",
  "customer_id": "cust_02c7t70ef3ig396idugupsr99j",
  "payment_method": "CARD",
  "created_at": 1727875117482,
  "card": {
    "card_type": "VISA",
    "card_fingerprint": "8411d8248f977bce15fba0f495474e4099j15bb9318fda8f0e700a4ad83b7836",
    "card_funding": "debit",
    "masked_number": "400934******1881",
    "expiration_date": "01/27"
  }
}

Delete Customer Payment Method

Request

Delete a payment method for a given customer

Path

merchant_idstringrequired

Unique identifier for the merchant

Example: merchant_01j8emz8chfxbb2bqmtref8ch7

customer_idstringrequired

Unique identifier for the customer

Example: cust_02c7t70ef3ig396idugupsr99j

payment_method_idstringrequired

Unique identifier for the payment method

Example: fxbb2bqmtref8ch7

curl -i -X DELETE \
  -u <username>:<password> \
  https://docs.taluspay.com/_mock/openapi/v1/merchants/merchant_01j8emz8chfxbb2bqmtref8ch7/customers/cust_02c7t70ef3ig396idugupsr99j/payment_methods/fxbb2bqmtref8ch7

Responses

Payment method deleted successfully

Onboarding Links

Operations

Webhooks

Operations

Statements

Operations

Payments

Operations

Refunds

Operations

Charges

Operations

TalusPay API (v1)

Merchants

Create merchant

Request

Responses

Was this helpful?

Get merchant

Request

Responses

Was this helpful?

Update merchant

Request

Responses

Was this helpful?

Create Customer

Request

Responses

Was this helpful?

Get Customer Payment Methods

Request

Responses

Was this helpful?

Create Customer Payment Method

Request

Responses

Was this helpful?

Get Customer Payment Method By Fingerprint

Request

Responses

Was this helpful?

Delete Customer Payment Method

Request

Responses

Was this helpful?

Onboarding Links

Webhooks

Statements

Payments

Refunds

Charges

TalusPay API (v1)

Merchants

Create merchant

RequestExpand all

Responses

Was this helpful?

Get merchant

Request

Responses

Was this helpful?

Update merchant

RequestExpand all

Responses

Was this helpful?

Create Customer

Request

Responses

Was this helpful?

Get Customer Payment Methods

Request

Responses

Was this helpful?

Create Customer Payment Method

Request

Responses

Was this helpful?

Get Customer Payment Method By Fingerprint

Request

Responses

Was this helpful?

Delete Customer Payment Method

Request

Responses

Was this helpful?

Onboarding Links

Webhooks

Statements

Payments

Refunds

Charges

Request

Request