API Reference

Initiate Direct Debit GSI

post
https://api.usezeeh.com/v1/direct_debit_gsi

To inititate Direct Debit GSI to withdraw payments from your customers' bank accounts following the customer's signing of a mandate to permit these transactions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
Defaults to 10000

The payment total value in the countries currency e.g NGN (Nigeria)

boolean
Defaults to true

If true, It will automatically generate installments using frequency and duration to calculate the number of installments; The first installment will be on the start_date; The value for each instalment, will be amount divided by number of installments. If False, It won't automatically generate installments

string
Defaults to weekly

if generate_payments = true; options daily, weekly, monthly

string
Defaults to Testing In Sandbox

The payment's description

date
Defaults to 2023-11-25

The date at which the direct debit gsi was initiated and must be in the future

int32
Defaults to 10

The duration or time frame for which the direct debit authorization remains valid, either weekly or monthly and must be under 1464 days

payer_data
object

This field returns an object containing all the payer's data information.

Headers
string
Responses

Updated almost 2 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 2 years ago