Overview
To enable seamless payments through SynchPay, you can allow users to authorize recurring charges up to a defined limit. This is managed through the Debit Auth API endpoints, which allow you to check, set, and update the user’s authorized debit limit.How It Works
1
Obtain an Access Token
Before calling any Debit Auth endpoints, secure an access token by making a
POST request to /auth/token using your ClientId and ClientSecret.2
Check Current Limit
Use the
GET /user/{registrationId}/debitauth endpoint to retrieve the current auto-debit authorization status and the active limit, if any.3
Set Initial Limit
If the user has not authorized any auto-debits yet, initiate the setup by sending a
POST request to /user/{registrationId}/debitauth with the desired limit.Check Current Debit Authorization
Endpoint
- URL:
https://api.synchpay.com/user/{registrationId}/debitauth - Method:
GET - Authorization:
Bearer <AccessToken>
Query Parameters
Example Request
Example Response
Set a New Debit Authorization Limit
Endpoint
- URL:
https://api.synchpay.com/user/{registrationId}/debitauth - Method:
POST - Authorization:
Bearer <AccessToken>