- REST APIs
- Welcome
- Cards
- 3D Secure 2
- Vault
- Getting Started
- Using the API
- Typical API Calls
- Verify That the Service Is Accessible
- Create a Profile for a Customer
- Add an Address to a Profile
- Add a Card to a Profile
- Add a Bank Account to a Profile
- Create an Apple Pay Single-Use Token
- Create a Google Pay Single-Use Token
- Create a Mobile Single-Use Token
- Create a Direct Debit Single-Use Token
- Process a Transaction Using a Payment Token
- API Reference
- Test and Go Live
- Direct Debit
- Apple Pay
- Google Pay
- Alternate Payments
- Platforms
- Overview
- Account Management
- Getting Started
- Using the API
- Typical API Calls
- Verify That the Service Is Accessible
- Create a New Merchant
- Create a New Merchant Account
- Create a New User
- Add an Address
- Create a Business Owner
- Add a Business Owner Address
- Add a Business Owner Identity Document
- Add a Merchant Bank Account
- Accept Our Terms and Conditions
- Activate the New Merchant Account
- Validate the Bank Account
- Enable Webhooks to Receive Application Statuses
- Test and Go Live
- Subaccounts
- Split Payouts
- Balance Transfers
- Paysafe Payments API
- Reference Information
- SDKs
- Additional Documentation
- Resources and Support
- Shopping Carts
- Classic APIs
- Glossary
Settlements
The payment Settlement is a process through which a merchant receives the money paid by the Customer for a specific product or service offered. There are two types of Settlements:
-
Auto Settlement
-
Manual Settlement
When the Customer completes a payment, the funds are immediately transferred to your (merchant) account in the case of auto settlement. In this case, no further action is required by the merchant. Auto settlement happens when the parameter settleWithAuth is set to true. By default, the settleWithAuth is true.
A merchant must manually settle a purchase request in the case of manual settlement. Manual settlement happens when the parameter settleWithAuth is false.
When a payment is authorized, the funds are guaranteed by the issuer, and the amount is held on the Customer’s card for up to seven days. If the Payment is not captured within this time, the Payment is cancelled, and funds are released.
To process a Settlement, you must initiate a POST request to the settlements endpoint using the Payment Id.
POST/paymenthub/v1/payments/payment_id/settlements
See our full API documentation for a complete description of the parameters required for the Settlement request.