Payment Methods
The payment method endpoints allow you to create, update, and view the payment methods associated with your account. You'll be able to see if any are set to expire and identify which one is the default payment method on file.
eHub provides a comprehensive set of endpoints to manage your payment methods efficiently. Whether you need to list all payment methods, create a new one, update existing details, retrieve specific information, or delete a payment method, these tools ensure smooth payment operations and financial management. Below are the key functionalities available for managing payment methods.
Payment Methods Endpoints
List All Payment Methods
Use this endpoint to retrieve a list of all payment methods associated with your eHub account. It provides details such as account numbers, billing information, payment types, and default status.
- Method:
GET /api/v2/payment_methods - Use Case: Quickly view and manage all the payment methods available under your account for review or updates.
Create a New Payment Method
This endpoint allows you to add a new payment method to your eHub account. Specify billing location, account type, and other necessary details to integrate a new payment method.
- Method:
POST /api/v2/payment_methods - Use Case: Add a new credit card, ACH, or other payment method to your account to ensure uninterrupted payment processing.
Update a Payment Method
If you need to modify details of an existing payment method, such as updating billing information or changing the default status, this endpoint allows you to update the necessary fields without recreating the payment method.
- Method:
PUT /api/v2/payment_methods/{id} - Use Case: Keep your payment methods up-to-date, such as updating expiry dates or modifying billing addresses, without creating a new payment method.
Retrieve a Payment Method
This endpoint allows you to retrieve detailed information for a specific payment method using its unique ID. It is useful when you need to review a specific account's details, such as payment type, billing location, or account number.
- Method:
GET /api/v2/payment_methods/{id} - Use Case: Get detailed information about a single payment method, such as verifying the billing address or checking the account number on file.
Summary
The Payment Methods API gives you full control over managing the financial aspects of your eHub account, from adding new payment methods to updating or retrieving existing ones. By using these tools, you can ensure your payment processes are efficient, secure, and up-to-date.
On this page
- Payment Methods