POST /paymentrequest
Servers
- https://api.paystack.co
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
draft |
Boolean | No |
Indicate if request should be saved as draft. Defaults to false and overrides send_notification |
split_code |
String | No |
The split code of the transaction split. |
tax[] |
Array | No |
Array of taxes |
customer |
String | Yes |
Customer id or code |
description |
String | No |
A short description of the payment request |
line_items[] |
Array | No |
Array of line items |
invoice_number |
Integer | No |
Numeric value of invoice. Invoice will start from 1 and auto increment from there. This field is to help override whatever value Paystack decides. Auto increment for subsequent invoices continue from this point. |
amount |
Integer | No |
Payment request amount. Only useful if line items and tax values are ignored. The endpoint will throw a friendly warning if neither is available. |
send_notification |
Boolean | No |
Indicates whether Paystack sends an email notification to customer. Defaults to true |
currency |
String | No |
Specify the currency of the invoice. Allowed values are NGN, GHS, ZAR and USD. Defaults to NGN |
has_invoice |
Boolean | No |
Set to true to create a draft invoice (adds an auto incrementing invoice number if none is provided) even if there are no line_items or tax passed |
due_date |
String | No |
ISO 8601 representation of request due date |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.