payments transactions

Time	Status	User Agent
Retrieving recent requests…

Query Parameters

Parameter	Type	Required	Description
`page`	integer	No	Page number to return. Defaults to `1`.
`per_page`	integer	No	Items per page.
`service_type`	string	No	Filter by kind: `payment` (card + virtual-account collections) or `payout` (merchant payouts). Omit to return both.
`payment_method_id`	string (uuid)	No	Return only transactions for a specific payment method (e.g. a virtual account id).
`type`	string	No	Direction of the transaction: `debit` or `credit`.
`status`	string	No	Transaction status: `pending`, `success`, or `failed`.
`refund_status`	string	No	Refund state: `none`, `partially_refunded`, `refunded`, or `refund_failed`.
`currency`	string	No	ISO currency code, e.g. `NGN`.
`merchant_reference`	string	No	Filter by the merchant reference you supplied at creation.
`date_from`	string	No	Inclusive start date, `YYYY-MM-DD`.
`date_to`	string	No	Inclusive end date, `YYYY-MM-DD`.
`settlement_id`	string (uuid)	No	Return only transactions in a given settlement.
`payment_id`	string (uuid)	No	Filter by payment id.

data

Field	Type	Description
`transactions`	array	List of transactions for this page.
`page_info`	object	Pagination metadata.

data.transactions[]

Field	Type	Description
`id`	string	Transaction id.
`reference`	string	Merchant reference.
`status`	string	`pending`, `success`, or `failed`.
`refund_status`	string	`none`, `partially_refunded`, `refunded`, or `refund_failed`.
`settle_status`	string	Settlement state: `initiated`, `pending`, `approved`, `released`, or `rejected`.
`amount`	number	Transaction amount.
`fee`	number	Fee charged.
`currency`	string	ISO currency code.
`payment_timestamp`	string (date-time)	When the transaction was created.
`response_code`	string	Provider/processor response code (when applicable).
`response_summary`	string	Human-readable response summary.
`total_amount_captured`	number	Amount captured (successful transactions).
`total_amount_available_to_refund`	number	Amount still refundable.
`total_amount_refunded`	number	Amount already refunded.
`source`	object	Card details — present for card payments.
`virtual_account_details`	object	Receiving virtual account — present for virtual-account collections.
`customer`	object	Sender (virtual-account collections) or beneficiary (payouts).

source (card payments)

Field	Type	Description
`type`	string	`card`.
`card_type`	string	Card scheme, e.g. `visa`, `mastercard`.
`card_bin`	string	First 6 digits.
`card_last4`	string	Last 4 digits.

virtual_account_details (virtual-account collections)

Field	Type	Description
`account_number`	string	Virtual account number that received funds.
`bank`	string	Bank name.
`account_name`	string	Account name.
`expected_amount`	string	Amount expected.
`amount_received`	string	Amount actually received.
`expires_at`	string (date-time)	When the account expires(d).
`status`	string	Collection status.

customer (virtual-account sender / payout beneficiary)

data.page_info

Field	Type	Description
`page`	integer	Current page.
`per_page`	integer	Items per page.
`previous_page`	boolean	Whether a previous page exists.
`next_page`	boolean	Whether a next page exists.
`page_count`	integer	Total number of pages.
`total`	integer	Total matching transactions.

{ "success": false, "error": { "message": "business not found" } }

{ "success": false, "error": { "message": "something went wrong" } }