Onboarding

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-sandbox.com
TalusPay engineering@taluspay.com
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/

Onboarding

Operations

Send OTP Code

Request

Bodyapplication/jsonrequired
phonestringrequired
curl -i -X POST \
  https://docs.taluspay.com/_mock/openapi/v1/onboarding/register_number \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "string"
  }'

Responses

Send otp code to mobile number.

Bodyapplication/json
messagestringrequired
Response
application/json
{
  "message": "string"
}

Verify number

Request

Bodyapplication/jsonrequired
phonestringrequired
publishable_keystringrequired
codestringrequired
agentnumber
curl -i -X POST \
  https://docs.taluspay.com/_mock/openapi/v1/onboarding/verify_number \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "string",
    "publishable_key": "string",
    "code": "string",
    "agent": 0
  }'

Responses

Verification code with mobile number. If everything works we create merchant and return JWT token

Bodyapplication/json
idstringrequired
tokenstringrequired
phonestringrequired
created_atstringrequired
publishable_keystringrequired
Response
application/json
{
  "id": "string",
  "token": "string",
  "phone": "string",
  "created_at": "string",
  "publishable_key": "string"
}

Get onboarding application

Request

Path
idnumberrequired
curl -i -X GET \
  'https://docs.taluspay.com/_mock/openapi/v1/onboarding/application/{application_id}'

Responses

Get lead

Bodyapplication/json
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_typestring(TinType)required
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
Response
application/json
{
  "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": { … },
    "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": { … },
    "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": { … },
    "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": { … },
    "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": { … },
    "average_amex_monthly_sales": "string",
    "average_amex_ticket_value": "string"
  }
}

Update onboarding application

Request

Path
application_idnumberrequired
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_typestring(TinType)required
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
curl -i -X PUT \
  'https://docs.taluspay.com/_mock/openapi/v1/onboarding/application/{application_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"
    }
  }'

Responses

Update application

Bodyapplication/json
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_typestring(TinType)required
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
Response
application/json
{
  "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": { … },
    "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": { … },
    "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": { … },
    "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": { … },
    "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": { … },
    "average_amex_monthly_sales": "string",
    "average_amex_ticket_value": "string"
  }
}

Create onboarding application

Request

Bodyapplication/jsonrequired
legal_business_namestringrequired
legal_phonestringrequired
doing_business_asstringrequired

Doing business as

dba_addressobjectrequired

Business address

dba_address.​addressstringrequired
dba_address.​citystringrequired
dba_address.​statestringrequired
dba_address.​zipstringrequired
ownerobject(OwnerLeadDto)required
owner.​first_namestringrequired
owner.​last_namestringrequired
owner.​emailstringrequired
curl -i -X POST \
  https://docs.taluspay.com/_mock/openapi/v1/onboarding/application \
  -H 'Content-Type: application/json' \
  -d '{
    "legal_business_name": "string",
    "legal_phone": "string",
    "doing_business_as": "string",
    "dba_address": {
      "address": "string",
      "city": "string",
      "state": "string",
      "zip": "string"
    },
    "owner": {
      "first_name": "string",
      "last_name": "string",
      "email": "string"
    }
  }'

Responses

Create application

Bodyapplication/json
lead_idnumberrequired
messagestringrequired
Response
application/json
{
  "lead_id": 0,
  "message": "string"
}

Create onboarding application signature

Request

Path
application_idnumberrequired
curl -i -X POST \
  'https://docs.taluspay.com/_mock/openapi/v1/onboarding/application/{application_id}/signature'

Responses

Create onboarding application signature, which is required to sign in web by first owner

Get onboarding application status

Request

curl -i -X GET \
  https://docs.taluspay.com/_mock/openapi/v1/onboarding/status \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

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_idnumber or nullrequired

Onboarding application ID

lead_onboarding_statusstring or null(OnboardingStatus)required

Merchant onboarding status

Enum"NOT_STARTED""IN_PROGRESS""COMPLETED""APPROVED""FAILED"
merchantobject or nullrequired

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_typestring(TinType)required
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
paymentobject or nullrequired

Merchant payment information

payment.​tokenizer_publishable_keystringrequired

Public key used for tokenizer

Example: "pub_XXXXXXXXXXXXXX"
payment.​terminal_idstringrequired

Terminal ID

Example: "Cx78a65ada9"
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": { … }
  },
  "payment": {
    "tokenizer_publishable_key": "pub_XXXXXXXXXXXXXX",
    "terminal_id": "Cx78a65ada9"
  }
}

Application onboarding signed statusDeprecated

Request

Path
application_idnumberrequired
curl -i -X GET \
  'https://docs.taluspay.com/_mock/openapi/v1/onboarding/application/{application_id}/signed'

Responses

Check if application was signed by anyone - temporary endpoint

Merchants

Operations

Webhooks

Operations

Payments

Operations

Charges

Operations