Skip to content

Latest commit

 

History

History
206 lines (157 loc) · 3.66 KB

File metadata and controls

206 lines (157 loc) · 3.66 KB

Transaction

A collection of endpoints for managing payments

Methods

Method HTTP Path Summary
charge_authorization POST /transaction/charge_authorization Charge Authorization
export GET /transaction/export Export Transactions
fetch GET /transaction/{id} Fetch Transaction
initialize POST /transaction/initialize Initialize Transaction
list GET /transaction List Transactions
partial_debit POST /transaction/partial_debit Partial Debit
timeline GET /transaction/timeline/{id} Fetch Transaction Timeline
totals GET /transaction/totals Transaction Totals
verify GET /transaction/verify/{reference} Verify Transaction

charge_authorization

HTTP: POST
Path: /transaction/charge_authorization

paystack.transaction.charge_authorization({ ... })

Body Fields

Name Required
email true
amount true
authorization_code true
reference false
currency false
split_code false
split false
subaccount false
transaction_charge false
bearer false
metadata false
queue false

export

HTTP: GET
Path: /transaction/export

paystack.transaction.export({ ... })

Query Fields

Name Required
from false
to false
status false
customer false
subaccount_code false
settlement false

fetch

HTTP: GET
Path: /transaction/{id}

paystack.transaction.fetch(id)

Path Parameters

Name Required
id true

initialize

HTTP: POST
Path: /transaction/initialize

paystack.transaction.initialize({ ... })

Body Fields

Name Required
email true
amount true
currency false
reference false
channels false
callback_url false
plan false
invoice_limit false
split_code false
split false
subaccount false
transaction_charge false
bearer false
label false
metadata false

list

HTTP: GET
Path: /transaction

paystack.transaction.list({ ... })

Query Fields

Name Required
use_cursor false
next false
previous false
per_page false
page false
from false
to false
status false
source false
terminal_id false
virtual_account_number false
customer_code false
amount false
settlement false
channel false
subaccount_code false
split_code false

partial_debit

HTTP: POST
Path: /transaction/partial_debit

paystack.transaction.partial_debit({ ... })

Body Fields

Name Required
email true
amount true
authorization_code true
currency true
at_least false
reference false

timeline

HTTP: GET
Path: /transaction/timeline/{id}

paystack.transaction.timeline(id)

Path Parameters

Name Required
id true

totals

HTTP: GET
Path: /transaction/totals

paystack.transaction.totals({ ... })

Query Fields

Name Required
from false
to false

verify

HTTP: GET
Path: /transaction/verify/{reference}

paystack.transaction.verify(reference)

Path Parameters

Name Required
reference true