# TalusPay API

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](https://status.taluspay.com)

Version: v1

## Servers

Production environment onboarding
```
https://api.taluspay.com
```

Sandbox environment onboarding
```
https://api.taluspay-sandbox.com
```

## Security

### account-merchant-session-token

Current accounts merchant auth session token - using JWT

Type: http
Scheme: bearer
Bearer Format: JWT

### account-secret

Combination of base64 encode of account_sid:account_secret_key

Type: http
Scheme: basic

## Download OpenAPI description

[TalusPay API](https://docs.taluspay.com/_bundle/openapi.yaml)

## Merchants

### Create merchant

 - [POST /v1/merchants](https://docs.taluspay.com/openapi/merchants/create%20merchant.md)

### Get merchant

 - [GET /v1/merchants/{merchant_id}](https://docs.taluspay.com/openapi/merchants/get%20merchant.md)

### Update merchant

 - [PATCH /v1/merchants/{merchant_id}](https://docs.taluspay.com/openapi/merchants/update%20merchant.md)

### Create Customer

 - [POST /v1/merchants/{merchant_id}/customers](https://docs.taluspay.com/openapi/merchants/create%20customer.md): Create a customer for a given merchant

### Get Customer Payment Methods

 - [GET /v1/merchants/{merchant_id}/customers/{customer_id}/payment_methods](https://docs.taluspay.com/openapi/merchants/get%20customer%20payment%20methods.md): Retrieve payment methods for a given customer

### Create Customer Payment Method

 - [POST /v1/merchants/{merchant_id}/customers/{customer_id}/payment_methods](https://docs.taluspay.com/openapi/merchants/create%20customer%20payment%20method.md): Create a payment method for a given customer

### Get Customer Payment Method By Fingerprint

 - [GET /v1/merchants/{merchant_id}/customers/{customer_id}/payment_methods/{card_fingerprint}](https://docs.taluspay.com/openapi/merchants/get%20customer%20payment%20method%20by%20fingerprint.md): Retrieve payment method for a given fingerprint

### Delete Customer Payment Method

 - [DELETE /v1/merchants/{merchant_id}/customers/{customer_id}/payment_methods/{payment_method_id}](https://docs.taluspay.com/openapi/merchants/delete%20customer%20payment%20method.md): Delete a payment method for a given customer

## Onboarding Links

### Create an onboarding link for a merchant

 - [POST /v1/onboarding_links](https://docs.taluspay.com/openapi/onboarding-links/create%20onboarding%20link.md): Creates a new onboarding link for a merchant. Important: Creating a new link will automatically expire all previous onboarding links for the same merchant.

## Webhooks

### Create webhook

 - [POST /v1/webhooks](https://docs.taluspay.com/openapi/webhooks/create%20webhook.md)

### Get webhook

 - [GET /v1/webhooks](https://docs.taluspay.com/openapi/webhooks/get%20webhook.md)

### Delete webhook

 - [DELETE /v1/webhooks/{webhook_id}](https://docs.taluspay.com/openapi/webhooks/delete%20webhook.md)

## Statements

### Get merchant statements

 - [GET /v1/statements/{merchantId}](https://docs.taluspay.com/openapi/statements/statements%20get.md): Retrieve a list of available monthly statements for the authenticated merchant

### Download a statement PDF

 - [GET /v1/statements/{merchantId}/download/{statementId}](https://docs.taluspay.com/openapi/statements/statements%20download.md): Download a specific monthly statement PDF with ISV branding applied

## Payments

### Create Terminal Payment

 - [POST /v1/terminal](https://docs.taluspay.com/openapi/payments/create%20terminal%20payment.md): Create a terminal payment

### Create Scan To Pay Payment

 - [POST /v1/scan_to_pay](https://docs.taluspay.com/openapi/payments/create%20scan%20to%20pay%20payment.md): Create a scan-to-pay payment

### Create Manual Payment

 - [POST /v1/manual](https://docs.taluspay.com/openapi/payments/create%20manual%20payment.md): Create a manual payment

### Create Invoice Payment

 - [POST /v1/invoice](https://docs.taluspay.com/openapi/payments/create%20invoice%20payment.md): Create an invoice payment

### Create Customer Payment

 - [POST /v1/customer_charge](https://docs.taluspay.com/openapi/payments/create%20customer%20payment.md): Create a customer payment

## Refunds

### Create Refund

 - [POST /v1/refunds](https://docs.taluspay.com/openapi/refunds/create%20refund.md): Create a Refund

### Get Refund

 - [GET /v1/refunds/{refund_id}](https://docs.taluspay.com/openapi/refunds/get%20refund.md): Retrieve a Refund by its ID

## Charges

### Get Charge

 - [GET /v1/charges/{charge_id}](https://docs.taluspay.com/openapi/charges/get%20charge.md): Retrieve a charge by its ID