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

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

Merchants

Operations

Create merchant

Request

Bodyapplication/jsonrequired

phonestringrequired

agentnumber

merchantobject(PublicLeadDto)

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"
      }
    }
  }'

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_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"
  }
}

Create merchant session token

Request

Path

merchant_idstringrequired

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

Responses

Create merchant session token to enable onboarding calls

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 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_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"
  }
}

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_id}/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: "customer_02c6h71gf3ea3786iyngbpjr38p"

descriptionstring

Some description

Example: "My customer"

Response

application/json

{
  "id": "customer_02c6h71gf3ea3786iyngbpjr38p",
  "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: fxbb2bqmtref8ch7

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

Responses

Payment methods retrieved successfully

Bodyapplication/json

idstringrequired

Unique identifier for the created payment method

Example: "payment_method_04c7h77rf3ig386ilngopty49z"

payment_methodstringrequired

Details of the payment method

Value"CARD"

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"

Response

application/json

{
  "id": "payment_method_04c7h77rf3ig386ilngopty49z",
  "payment_method": "CARD",
  "card": {
    "card_type": "VISA",
    "card_fingerprint": "8411d8248f977bce15fba0f495474e4099j15bb9318fda8f0e700a4ad83b7836",
    "card_funding": "debit"
  }
}

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: fxbb2bqmtref8ch7

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_id}/customers/{customer_id}/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"

payment_methodstringrequired

Details of the payment method

Value"CARD"

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"

Response

application/json

{
  "id": "payment_method_04c7h77rf3ig386ilngopty49z",
  "payment_method": "CARD",
  "card": {
    "card_type": "VISA",
    "card_fingerprint": "8411d8248f977bce15fba0f495474e4099j15bb9318fda8f0e700a4ad83b7836",
    "card_funding": "debit"
  }
}

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: fxbb2bqmtref8ch7

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_id}/customers/{customer_id}/payment_methods/{payment_method_id}'

Responses

Payment method deleted successfully

Webhooks

Operations

Payments

Operations

Charges

Operations

TalusPay API (v1)

Onboarding

Merchants

Create merchant

Request

Responses

Was this helpful?

Create merchant session token

Request

Responses

Was this helpful?

Get 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?

Delete Customer Payment Method

Request

Responses

Was this helpful?

Webhooks

Payments

Charges

TalusPay API (v1)

Onboarding

Merchants

Create merchant

RequestExpand all

Responses

Was this helpful?

Create merchant session token

Request

Responses

Was this helpful?

Get 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?

Delete Customer Payment Method

Request

Responses

Was this helpful?

Webhooks

Payments

Charges

Request