A recurring profile lets you charge the client later without the client confirming every payment.
Supported payment systems: Bybit Pay and Binance Pay.
The client confirms the profile once in the app of the payment system; then you charge it with Execute. Headers, signature and errors are the same as in Invoice API: see Invoice Overview. Recurring payments are in development: the methods may change.
How it works#
1.
Create the profile with Create: the response contains profile_id and the link url. 2.
Give the client url: the client confirms the profile in the app of the payment system.
3.
Wait for the status active: a notification to state_callback (Notify) or Info. 4.
Charge the client with Execute as many times as needed while the profile is active. 5.
Cancel the profile with Cancel when the charges are no longer needed. Methods#
| Method | What it does |
|---|
| Create | Creates a profile and returns the link for the client. |
| Info | Returns the details and the status of a profile. |
| Cancel | Cancels a profile. |
| Execute | Charges the client by an active profile. |
| Notify | Notification about the profile status to state_callback. |
Profile statuses#
| Status | Meaning | Final |
|---|
process | The profile is created and waits for the client to confirm it. | No |
active | The client confirmed the profile: it can be charged with Execute. | No |
canceled | The profile is cancelled with Cancel. | Yes |
expired | The profile expired: expires_at has passed. | Yes |
error | The payment system did not create the profile. | Yes |
Only an active profile can be charged.