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
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/

Merchants

Operations

Webhooks

Operations

Statements

Operations

Get merchant statements

Request

Retrieve a list of available monthly statements for the authenticated merchant

Path
merchantIdstringrequired

The unique identifier of the merchant

Example: merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k
curl -i -X GET \
  -u <username>:<password> \
  https://docs.taluspay.com/_mock/openapi/v1/statements/merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k

Responses

List of statements for the merchant

Bodyapplication/json
statementsArray of objects(StatementMetadataDto)required

List of available statements for the merchant

statements[].​statement_idstringrequired

Unique identifier for the statement

Example: "stmt_2024_01_abc123"
statements[].​merchant_idstringrequired

Merchant identifier

Example: "merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k"
statements[].​statement_datestringrequired

Statement date in YYYY-MM-DD format

Example: "2024-01-31"
statements[].​period_startstringrequired

Period start date in YYYY-MM-DD format

Example: "2024-01-01"
statements[].​period_endstringrequired

Period end date in YYYY-MM-DD format

Example: "2024-01-31"
statements[].​total_amountnumberrequired

Total amount for the statement period

Example: 1250.75
statements[].​currencystringrequired

Currency code

Example: "USD"
statements[].​statusstringrequired

Statement status

Enum"available""processing""error"
Example: "available"
statements[].​download_urlstring

Download URL for the statement

Example: "https://api.taluspay.com/v1/statements/download/stmt_2024_01_abc123"
total_countnumberrequired

Total number of statements available

Example: 5
merchant_idstringrequired

Merchant identifier

Example: "merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k"
Response
application/json
{ "statements": [ { … } ], "total_count": 5, "merchant_id": "merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k" }

Download a statement PDF

Request

Download a specific monthly statement PDF with ISV branding applied

Path
merchantIdstringrequired

The unique identifier of the merchant

Example: merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k
statementIdstringrequired

The unique identifier of the statement to download

Example: 859963
curl -i -X GET \
  -u <username>:<password> \
  https://docs.taluspay.com/_mock/openapi/v1/statements/merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k/download/859963

Responses

PDF statement file successfully downloaded

Payments

Operations

Refunds

Operations

Charges

Operations