Refunds

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

Refunds

Operations

Create Refund

Request

Create a Refund

Bodyapplication/jsonrequired
charge_idstringrequired

Unique identifier for the charge

Example: "ch_01j8emz8chfxbb2bqmtref8ch7"
merchant_idstringrequired

Unique identifier for the merchant

Example: "merchant_02c7h71rf3eg396idngupsr66t"
amountinteger(int32)required

Amount of the refund

Example: 100
notesstring

Some notes

Example: "My refund"
curl -i -X POST \
  https://docs.taluspay.com/_mock/openapi/v1/refunds \
  -H 'Content-Type: application/json' \
  -d '{
    "charge_id": "ch_01j8emz8chfxbb2bqmtref8ch7",
    "merchant_id": "merchant_02c7h71rf3eg396idngupsr66t",
    "amount": 100,
    "notes": "My refund"
  }'

Responses

Refund created successfully

Bodyapplication/json
idstringrequired

Unique identifier for the refund

Example: "re_01j8emz8chfxbb2bqmtref8ch7"
charge_idstringrequired

Unique identifier for the charge

Example: "ch_01j8emz8chfxbb2bqmtref8ch7"
merchant_idstringrequired

Unique identifier for the merchant

Example: "merchant_02c7h71rf3eg396idngupsr66t"
amountinteger(int32)required

Amount of the refund

Example: 100
notesstring

Some notes

Example: "My refund"
created_atinteger(int32)required

Timestamp in milliseconds when the refund was created

Example: 1727875117482
Response
application/json
{
  "id": "re_01j8emz8chfxbb2bqmtref8ch7",
  "charge_id": "ch_01j8emz8chfxbb2bqmtref8ch7",
  "merchant_id": "merchant_02c7h71rf3eg396idngupsr66t",
  "amount": 100,
  "notes": "My refund",
  "created_at": 1727875117482
}

Get Refund

Request

Retrieve a Refund by its ID

Path
refund_idStringrequired

Unique identifier for the refund

Example: re_09jb6y6791fg2bt0drtfvajtnl
curl -i -X GET \
  'https://docs.taluspay.com/_mock/openapi/v1/refunds/{refund_id}'

Responses

Refund retrieved successfully

Bodyapplication/json
idstringrequired

Unique identifier for the refund

Example: "re_01j8emz8chfxbb2bqmtref8ch7"
charge_idstringrequired

Unique identifier for the charge

Example: "ch_01j8emz8chfxbb2bqmtref8ch7"
merchant_idstringrequired

Unique identifier for the merchant

Example: "merchant_02c7h71rf3eg396idngupsr66t"
amountinteger(int32)required

Amount of the refund

Example: 100
notesstring

Some notes

Example: "My refund"
created_atinteger(int32)required

Timestamp in milliseconds when the refund was created

Example: 1727875117482
Response
application/json
{
  "id": "re_01j8emz8chfxbb2bqmtref8ch7",
  "charge_id": "ch_01j8emz8chfxbb2bqmtref8ch7",
  "merchant_id": "merchant_02c7h71rf3eg396idngupsr66t",
  "amount": 100,
  "notes": "My refund",
  "created_at": 1727875117482
}

Charges

Operations