/paystack-payments | Type: Application | PCID required: Yes
Tools
paystack_payments_charge_check
Check pending charge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
reference | string | Yes | — | The reference of the ongoing transaction |
paystack_payments_charge_create
Create Charge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
amount | integer | Yes | — | Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR |
authorization_code | string | No | — | An authorization code to charge. |
bank | object | No | — | The bank object if charging a bank account |
birthday | string | No | — | The customer’s birthday in the format YYYY-MM-DD e.g 2017-05-16 |
device_id | string | No | — | This is the unique identifier of the device a user uses in making payment. Only -, .`, = and alphanumeric characters are allowed. |
eft | object | No | — | Details of the EFT provider |
email | string | Yes | — | Customer’s email address |
metadata | object | No | — | JSON object of custom data |
mobile_money | object | No | — | Details of the mobile service provider |
pin | string | No | — | 4-digit PIN (send with a non-reusable authorization code) |
reference | string | No | — | Unique transaction reference. Only -, .`, = and alphanumeric characters allowed. |
ussd | object | No | — | The USSD code for the provider to charge |
paystack_payments_charge_submit_address
Submit Address Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | string | Yes | — | Customer’s address |
city | string | Yes | — | Customer’s city |
reference | string | Yes | — | The reference of the ongoing transaction |
state | string | Yes | — | Customer’s state |
zip_code | string | Yes | — | Customer’s zipcode |
paystack_payments_charge_submit_birthday
Submit Birthday Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
birthday | string | Yes | — | Customer’s birthday in the format YYYY-MM-DD e.g 2016-09-21 |
reference | string | Yes | — | The reference of the ongoing transaction |
paystack_payments_charge_submit_otp
Submit OTP Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
otp | string | Yes | — | Customer’s OTP for ongoing transaction |
reference | string | Yes | — | The reference of the ongoing transaction |
paystack_payments_charge_submit_phone
Submit Phone Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
phone | string | Yes | — | Customer’s mobile number |
reference | string | Yes | — | The reference of the ongoing transaction |
paystack_payments_charge_submit_pin
Submit PIN Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pin | string | Yes | — | Customer’s PIN for the ongoing transaction |
reference | string | Yes | — | Transaction reference that requires the PIN |
paystack_payments_dispute_download
Export Disputes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perPage | integer | No | — | Number of records to fetch per page |
page | integer | No | — | The section to retrieve |
status | string | No | — | The status value |
from | string | No | — | The start date |
to | string | No | — | The end date |
paystack_payments_dispute_evidence
Add Evidence Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The unique identifier of the dispute |
customer_email | string | Yes | — | Customer email |
customer_name | string | Yes | — | Customer name |
customer_phone | string | Yes | — | Customer mobile number |
delivery_address | string | No | — | Delivery address |
delivery_date | string | No | — | ISO 8601 representation of delivery date (YYYY-MM-DD) |
service_details | string | Yes | — | Details of service offered |
paystack_payments_dispute_fetch
Fetch Dispute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The unique identifier of the dispute |
paystack_payments_dispute_list
List Disputes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perPage | integer | No | — | Number of records to fetch per page |
page | integer | No | — | The section to retrieve |
status | string | No | — | Dispute status |
transaction | string | No | — | Transaction ID |
from | string | No | — | The start date |
to | string | No | — | The end date |
paystack_payments_dispute_resolve
Resolve Dispute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The unique identifier of the dispute |
evidence | integer | No | — | Evidence Id for fraud claims |
message | string | Yes | — | Reason for resolving |
refund_amount | integer | Yes | — | The amount to refund, in the subunit of your integration currency |
resolution | string | Yes | — | Dispute resolution. Accepted values, merchant-accepted, declined |
uploaded_filename | string | Yes | — | Filename of attachment returned via response from the Dispute upload URL |
paystack_payments_dispute_transaction
List Transaction Disputes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The unique identifier of the transaction |
paystack_payments_dispute_update
Update Dispute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The unique identifier of the dispute |
refund_amount | integer | Yes | — | The amount to refund, in the subunit of your currency |
uploaded_filename | string | No | — | Filename of attachment returned via response from the Dispute upload URL |
paystack_payments_dispute_upload_url
Fetch Upload URL Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The unique identifier of the dispute |
paystack_payments_payment_request_archive
Archive Payment Request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The unique identifier of a previously created payment request |
paystack_payments_payment_request_create
Create Payment Request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
amount | integer | Yes | — | Payment request amount. Only useful if line items and tax values are ignored. The endpoint will throw a friendly warning if neither is available. |
currency | string | No | — | Specify the currency of the invoice. Allowed values are NGN, GHS, ZAR and USD. Defaults to NGN |
customer | string | Yes | — | Customer id or code |
description | string | No | — | A short description of the payment request |
draft | boolean | No | — | Indicate if request should be saved as draft. Defaults to false and overrides send_notification |
due_date | string | No | — | ISO 8601 representation of request due date |
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 |
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. |
line_items | object[] | No | — | Array of line items |
send_notification | boolean | No | — | Indicates whether Paystack sends an email notification to customer. Defaults to true |
split_code | string | No | — | The split code of the transaction split. |
tax | object[] | No | — | Array of taxes |
paystack_payments_payment_request_fetch
Fetch Payment Request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The unique identifier of a previously created payment request |
paystack_payments_payment_request_finalize
Finalize Payment Request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The unique identifier of a draft payment request |
paystack_payments_payment_request_list
List Payment Request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perPage | integer | No | — | Number of records to fetch per page |
page | integer | No | — | The section to retrieve |
customer | string | No | — | Customer ID |
status | string | No | — | Invoice status to filter |
currency | string | No | — | If your integration supports more than one currency, choose the one to filter |
from | string | No | — | The start date |
to | string | No | — | The end date |
paystack_payments_payment_request_notify
Send Notification Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The unique identifier of a previously created payment request |
paystack_payments_payment_request_totals
Payment Request Totalpaystack_payments_payment_request_update
Update Payment Request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The unique identifier of a previously created payment request |
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. |
currency | string | No | — | Specify the currency of the invoice. Allowed values are NGN, GHS, ZAR and USD. Defaults to NGN |
customer | string | No | — | Customer id or code |
description | string | No | — | A short description of the payment request |
draft | boolean | No | — | Indicate if request should be saved as draft. Defaults to false and overrides send_notification |
due_date | string | No | — | ISO 8601 representation of request due date |
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 |
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. |
line_items | object[] | No | — | Array of line items |
send_notification | boolean | No | — | Indicates whether Paystack sends an email notification to customer. Defaults to true |
split_code | string | No | — | The split code of the transaction split. |
tax | object[] | No | — | Array of taxes |
paystack_payments_payment_request_verify
Verify Payment Request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The unique identifier of a previously created payment request |
paystack_payments_refund_create
Create Refund Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
amount | integer | No | — | Amount to be refunded to the customer. It cannot be more than the original transaction amount |
currency | string | No | — | Three-letter ISO currency |
customer_note | string | No | — | Customer reason |
merchant_note | string | No | — | Merchant reason |
transaction | string | Yes | — | The reference of a previosuly completed transaction |
paystack_payments_refund_fetch
Fetch Refund Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The identifier of the refund |
paystack_payments_refund_list
List Refunds Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perPage | integer | No | — | Number of records to fetch per page |
page | integer | No | — | The section to retrieve |
from | string | No | — | The start date |
to | string | No | — | The end date |
paystack_payments_refund_retry
Retry Refund Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The identifier of the refund |
refund_account_details | object | Yes | — | An object that contains the customer’s account details for refund |
paystack_payments_transaction_charge_authorization
Charge Authorization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
amount | integer | Yes | — | Amount in the lower denomination of your currency |
authorization_code | string | Yes | — | Valid authorization code to charge |
bearer | string | No | — | The bearer of the transaction charge |
currency | string | No | — | List of all support currencies |
email | string | Yes | — | Customer’s email address |
metadata | string | No | — | Stringified JSON object of custom data |
queue | boolean | No | — | If you are making a scheduled charge call, it is a good idea to queue them so the processing system does not get overloaded causing transaction processing errors. |
reference | string | No | — | Unique transaction reference. Only -, ., = and alphanumeric characters allowed. |
split | object | No | — | Split configuration for transactions |
split_code | string | No | — | The split code of the transaction split |
subaccount | string | No | — | The code for the subaccount that owns the payment |
transaction_charge | string | No | — | A flat fee to charge the subaccount for a transaction. This overrides the split percentage set when the subaccount was created |
paystack_payments_transaction_export
Export Transactions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The start date |
to | string | No | — | The end date |
status | string | No | — | Filter by the status of the transaction |
customer | number | No | — | Filter by customer ID |
subaccount_code | string | No | — | Filter by subaccount code |
settlement | integer | No | — | Filter by the settlement ID |
paystack_payments_transaction_fetch
Fetch Transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the transaction to fetch |
paystack_payments_transaction_initialize
Initialize Transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
amount | integer | Yes | — | Amount should be in smallest denomination of the currency. |
bearer | string | No | — | The bearer of the transaction charge |
callback_url | string | No | — | Fully qualified url, e.g. https://example.com/ to redirect your customers to after a successful payment. Use this to override the callback url provided on the dashboard for this transaction |
channels | string[] | No | — | An array of payment channels to control what channels you want to make available to the user to make a payment with |
currency | string | No | — | List of all support currencies |
email | string | Yes | — | Customer’s email address |
invoice_limit | integer | No | — | Number of times to charge customer during subscription to plan |
label | string | No | — | Used to replace the email address shown on the Checkout |
metadata | object | No | — | JSON object of custom data |
plan | string | No | — | If transaction is to create a subscription to a predefined plan, provide plan code here. This would invalidate the value provided in amount |
reference | string | No | — | Unique transaction reference. Only -, ., = and alphanumeric characters allowed. |
split | object | No | — | Split configuration for transactions |
split_code | string | No | — | The split code of the transaction split |
subaccount | string | No | — | The code for the subaccount that owns the payment |
transaction_charge | string | No | — | A flat fee to charge the subaccount for a transaction. This overrides the split percentage set when the subaccount was created |
paystack_payments_transaction_list
List Transactions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
use_cursor | boolean | No | — | A flag to indicate if cursor based pagination should be used |
next | string | No | — | An alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data |
previous | string | No | — | An alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data |
per_page | integer | No | — | The number of records to fetch per request |
page | integer | No | — | The offset to retrieve data from |
from | string | No | — | The start date |
to | string | No | — | The end date |
status | string | No | — | Filter transaction by status |
source | string | No | — | The origin of the payment |
terminal_id | string | No | — | Filter transactions by a terminal ID |
virtual_account_number | string | No | — | Filter transactions by a virtual account number |
customer_code | string | No | — | Filter transactions by a customer code |
amount | integer | No | — | Filter transactions by a specific amount |
settlement | integer | No | — | The settlement ID to filter for settled transactions |
channel | string | No | — | The payment method the customer used to complete the transaction |
subaccount_code | string | No | — | Filter transaction by subaccount code |
split_code | string | No | — | Filter transaction by split code |
paystack_payments_transaction_partial_debit
Partial Debit Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
amount | integer | Yes | — | Specified in the lowest denomination of your currency |
at_least | string | No | — | Minimum amount to charge |
authorization_code | string | Yes | — | Valid authorization code to charge |
currency | string | Yes | — | List of all support currencies |
email | string | Yes | — | Customer’s email address |
reference | string | No | — | Unique transaction reference. Only -, ., = and alphanumeric characters allowed. |
paystack_payments_transaction_timeline
Fetch Transaction Timeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the transaction to fetch |
paystack_payments_transaction_totals
Transaction Totals Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | The start date |
to | string | No | — | The end date |
paystack_payments_transaction_verify
Verify Transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
reference | string | Yes | — | The transaction reference to verify |

