Charges

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

Merchants

Operations

Webhooks

Operations

Payments

Operations

Charges

Operations

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

Responses

Charge retrieved successfully

Bodyapplication/json
idstring

Unique identifier for the charge

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

Unique identifier for the merchant

Example: "merchant_02c7h71rf3eg396idngupsr66t"
payment_typestringrequired

Type of payment for the charge

Example: "MANUAL"
amount_authorizedinteger(int32)required

Amount authorized for the charge

Example: 100
amount_capturedinteger(int32)required

Amount captured for the charge

Example: 100
requested_amountinteger(int32)required

Requested amount 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
card_entry_methodstringrequired

Method used for card entry

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

Billing address details

card_expiration_datestring

Expiration date of the card

Example: "01/27"
card_typestring

Type of the card

Example: "debit"
statusstringrequired

status of the charge

Example: "PENDING_SETTLEMENT"
Response
application/json
{
  "id": "charge_01j8emz8chfxbb2bqmtref8ch7",
  "merchant": {
    "id": "merchant_02c7h71rf3eg396idngupsr66t"
  },
  "payment_type": "MANUAL",
  "amount_authorized": 100,
  "amount_captured": 100,
  "requested_amount": 100,
  "tip": 1,
  "tax": 10,
  "card_last_4": "1234",
  "card_brand": "VISA",
  "created_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 Main St",
    "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",
  "status": "PENDING_SETTLEMENT"
}