Skip to content

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

Payments

Operations

Refunds

Operations

Charges

Operations

Get All Charges

Request

Retrieve all charges with pagination

Query
pageinteger>= 0

Page number (0-based)

Default 0
Example: page=0
limitinteger>= 1

Number of charges per page

Default 20
Example: limit=20
merchant_idstring

Optional merchant ID to filter charges

Example: merchant_id=merchant_01j3sc1n1keghbg5q97gr1s08m
payment_typestring

Optional payment type to filter charges

Enum"MANUAL""INVOICE""TERMINAL""SCAN_TO_PAY"
Example: payment_type=MANUAL
statusstring

Optional status to filter charges

Enum"AUTHORIZED""SETTLED"
Example: status=SETTLED
charge_idstring

Optional charge ID to filter charges

Example: charge_id=ch_01j8emz8chfxbb2bqmtref8ch7
curl -i -X GET \
  'https://docs.taluspay.com/_mock/openapi/v1/charges?page=0&limit=20&merchant_id=merchant_01j3sc1n1keghbg5q97gr1s08m&payment_type=MANUAL&status=SETTLED&charge_id=ch_01j8emz8chfxbb2bqmtref8ch7'

Responses

Charges retrieved successfully

Bodyapplication/json
chargesArray of objects(Charge)required
charges[].​idstring

Unique identifier for the charge

Example: "ch_01j8emz8chfxbb2bqmtref8ch7"
charges[].​merchantobject(Merchant)required
charges[].​merchant.​idstringrequired

Unique identifier for the merchant

Example: "merchant_02c7h71rf3eg396idngupsr66t"
charges[].​merchant.​gateway_merchant_idstring

Unique identifier for the merchant in the payment gateway

Example: "cs32cvc4i4783pdn9ml1"
charges[].​merchant.​api_keystring

Secret API key for the merchant

Example: "api_2y46nIaf2xjtD0B74aZ6oxhQRxL"
charges[].​merchant.​pub_api_keystring

Public API key for the merchant

Example: "pub_2y46nKsfnVmYQ7Fw6FTOhvS9l0F"
charges[].​merchant.​processorsArray of objects(MerchantProcessor)

Merchant processors

charges[].​payment_typestringrequired

Type of payment for the charge

Example: "MANUAL"
charges[].​statusstringrequired

status of the charge

Enum"AUTHORIZED""SETTLED"
Example: "SETTLED"
charges[].​requested_amountinteger(int32)required

Requested amount for the charge

Example: 100
charges[].​amount_authorizedinteger(int32)required

Amount authorized for the charge

Example: 100
charges[].​amount_capturedinteger(int32)required

Amount captured for the charge

Example: 100
charges[].​tipinteger(int32)required

Tip amount for the charge

Example: 1
charges[].​taxinteger(int32)required

Tax amount for the charge

Example: 10
charges[].​card_last_4string

Last 4 digits of the card used for the charge

Example: 1234
charges[].​card_brandstring

Brand of the card used for the charge

Example: "VISA"
charges[].​created_atinteger(int32)required

Timestamp when the charge was created

Example: 1727875117482
charges[].​authorized_atinteger(int32)

Timestamp when the charge was authorized

Example: 1727875117482
charges[].​captured_atinteger(int32)

Timestamp when the charge was captured

Example: 1727875117482
charges[].​settled_atinteger(int32)

Timestamp when the charge was settled

Example: 1727875117482
charges[].​card_entry_methodstringrequired

Method used for card entry

Enum"SWIPE""CHIP""MANUAL"
Example: "MANUAL"
charges[].​billing_addressobject(PaymentBillingAddress)
charges[].​card_expiration_datestring

Expiration date of the card

Example: "01/27"
charges[].​card_typestring

Type of the card

Example: "debit"
charges[].​failure_reasonstring

Reason for the charge failure

Example: "Card declined"
charges[].​refundsArray of objects(Refund)

List of refunds associated with this charge

totalinteger(int64)required
totalPagesinteger(int32)required
pageinteger(int32)required
sizeinteger(int32)required
Response
application/json
{
  "charges": [
    { … }
  ],
  "total": 0,
  "totalPages": 0,
  "page": 0,
  "size": 0
}

Get Charge

Request

Retrieve a charge by its ID

Path
charge_idstringrequired

Unique identifier for the charge

Example: charge_09jb6y6791fg2bt0drtfvajtnl
curl -i -X GET \
  https://docs.taluspay.com/_mock/openapi/v1/charges/charge_09jb6y6791fg2bt0drtfvajtnl

Responses

Charge retrieved successfully

Bodyapplication/json
idstring

Unique identifier for the charge

Example: "ch_01j8emz8chfxbb2bqmtref8ch7"
merchantobject(Merchant)required
merchant.​idstringrequired

Unique identifier for the merchant

Example: "merchant_02c7h71rf3eg396idngupsr66t"
merchant.​gateway_merchant_idstring

Unique identifier for the merchant in the payment gateway

Example: "cs32cvc4i4783pdn9ml1"
merchant.​api_keystring

Secret API key for the merchant

Example: "api_2y46nIaf2xjtD0B74aZ6oxhQRxL"
merchant.​pub_api_keystring

Public API key for the merchant

Example: "pub_2y46nKsfnVmYQ7Fw6FTOhvS9l0F"
merchant.​processorsArray of objects(MerchantProcessor)

Merchant processors

payment_typestringrequired

Type of payment for the charge

Example: "MANUAL"
statusstringrequired

status of the charge

Enum"AUTHORIZED""SETTLED"
Example: "SETTLED"
requested_amountinteger(int32)required

Requested amount for the charge

Example: 100
amount_authorizedinteger(int32)required

Amount authorized for the charge

Example: 100
amount_capturedinteger(int32)required

Amount captured for the charge

Example: 100
tipinteger(int32)required

Tip amount for the charge

Example: 1
taxinteger(int32)required

Tax amount for the charge

Example: 10
card_last_4string

Last 4 digits of the card used for the charge

Example: 1234
card_brandstring

Brand of the card used for the charge

Example: "VISA"
created_atinteger(int32)required

Timestamp when the charge was created

Example: 1727875117482
authorized_atinteger(int32)

Timestamp when the charge was authorized

Example: 1727875117482
captured_atinteger(int32)

Timestamp when the charge was captured

Example: 1727875117482
settled_atinteger(int32)

Timestamp when the charge was settled

Example: 1727875117482
card_entry_methodstringrequired

Method used for card entry

Enum"SWIPE""CHIP""MANUAL"
Example: "MANUAL"
billing_addressobject(PaymentBillingAddress)
card_expiration_datestring

Expiration date of the card

Example: "01/27"
card_typestring

Type of the card

Example: "debit"
failure_reasonstring

Reason for the charge failure

Example: "Card declined"
refundsArray of objects(Refund)

List of refunds associated with this charge

Response
application/json
{
  "id": "ch_01j8emz8chfxbb2bqmtref8ch7",
  "merchant": {
    "id": "merchant_02c7h71rf3eg396idngupsr66t",
    "gateway_merchant_id": "cs32cvc4i4783pdn9ml1",
    "api_key": "api_2y46nIaf2xjtD0B74aZ6oxhQRxL",
    "pub_api_key": "pub_2y46nKsfnVmYQ7Fw6FTOhvS9l0F",
    "processors": [ … ]
  },
  "payment_type": "MANUAL",
  "status": "SETTLED",
  "requested_amount": 100,
  "amount_authorized": 100,
  "amount_captured": 100,
  "tip": 1,
  "tax": 10,
  "card_last_4": 1234,
  "card_brand": "VISA",
  "created_at": 1727875117482,
  "authorized_at": 1727875117482,
  "captured_at": 1727875117482,
  "settled_at": 1727875117482,
  "card_entry_method": "MANUAL",
  "billing_address": {
    "company": "Acme Corp",
    "phone": "+1234567890",
    "email": "example@domain.com",
    "first_name": "John",
    "last_name": "Doe",
    "address_line_1": 123,
    "address_line_2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "postal_code": 10001,
    "country": "USA",
    "fax": "+1234567890"
  },
  "card_expiration_date": "01/27",
  "card_type": "debit",
  "failure_reason": "Card declined",
  "refunds": [
    { … }
  ]
}