Create a Debit transaction
Before you can create a debit payment link, make sure you have an API token with the Create Debit scope. See the Getting your API key section for more details.
First, you have to find the identifier for the bank account you wish the money to be deposited in.
Navigate to the Settings page on your Jetpay dashboard and select the Bank Accounts tab.
Click on the bank account you wish the transaction to be sent to. This will open a side panel with some information about the bank account.
The identifier is shown at the bottom, in this case ffe2c516-2ef4-4ce8-a1e1-1960c5b321ad.
Press the Copy button on the right which will copy the value of the identifier into your clipboard.
Make sure you have already saved the API Token before you do this.
Now that you have an API token and a bank account identifier, you are ready to initiate a transaction. See the API docs for the Create Debit operation for more details and additional languages. If you have followed the steps in Getting your API key, you can simply call the relevant call with the parameters we've gathered.
If you want to test this without setting up a client, you can do this by using CURL.
- Replace <your api token here> and <your bank account id here> with the token and id you just found, and
- fill in the amount, statement, note , contact_email and contact_name with the information you want to include.
- The note parameter is optional; it is shown in the Jetpay App for your reference and can be long enough to include more details than the statement, which is restricted to 30 characters.
Note that the email is included for KYC purposes but creating the transaction will not send them an email.
https:
If you have done everything correctly, you will receive a HTTP 201 response from the API indicating that the debit request was created.
On the right is a sample response. The "identifier" may be useful in the future if you want to query or cancel the transaction.
This request is not automatically sent via email, but rather this link must be sent by your company or included in an invoice.
When your customer clicks the link, it will open a payment checkout page that looks like this:
For more information about how we collect the payment, see Payment Methods .
