list payment transactions
GET/org/:orgId/paymentTransaction
List payment transactions with pagination and filters
Request
Path Parameters
Organization ID
Query Parameters
Optional, filter by the given buyer ID
Optional, filter by the given entitlement ID
Optional, filter by the given invoice ID
Possible values: [PENDING
, PROCESSING
, SUCCESS
, FAILED
]
Optional, filter by status
Possible values: [CHARGE
, REFUND
]
Optional, filter by transaction type
List pagination size, default 1000, max value is 1000
List pagination offset, default 0
Responses
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
info
object
The invoice issue date.
Refund flag marks whether the transaction has any refund records.
stripeBalanceTransaction
object
Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.
The date that the transaction's net funds become available in the Stripe balance.
ID of the charge which the balance transaction comes from.
Time at which the object was created. Measured in seconds since the Unix epoch.
An arbitrary string attached to the object. Often useful for displaying to users.
If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the amount
in currency A, multipled by the exchange_rate
, equals the amount
in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's amount
is 1000
and currency
is eur
. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's amount
is 1234
, its currency
is usd
, and the exchange_rate
is 1.234
.
Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.
fee_details
object[]
Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.
Amount of the fee, in cents.
ID of the Connect application that earned the fee.
An arbitrary string attached to the object. Often useful for displaying to users.
Type of the fee, one of: application_fee
, payment_method_passthrough_fee
, stripe_fee
or tax
.
Unique identifier for the object.
Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by amount
- fee
The transaction's net funds status in the Stripe balance, which are either available
or pending
.
Transaction type: adjustment
, advance
, advance_funding
, anticipation_repayment
, application_fee
, application_fee_refund
, charge
, climate_order_purchase
, climate_order_refund
, connect_collection_transfer
, contribution
, issuing_authorization_hold
, issuing_authorization_release
, issuing_dispute
, issuing_transaction
, obligation_outbound
, obligation_reversal_inbound
, payment
, payment_failure_refund
, payment_network_reserve_hold
, payment_network_reserve_release
, payment_refund
, payment_reversal
, payment_unreconciled
, payout
, payout_cancel
, payout_failure
, refund
, refund_failure
, reserve_transaction
, reserved_funds
, stripe_fee
, stripe_fx_fee
, tax_fee
, topup
, topup_reversal
, transfer
, transfer_cancel
, transfer_failure
, or transfer_refund
. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, consider reporting_category
instead.
stripeDisputes
object[]
Stripe dispute result, got by Dispute API, there may be multiple disputes.
Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).
ID of the charge that's disputed.
Time at which the object was created. Measured in seconds since the Unix epoch.
Unique identifier for the object.
If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.
Has the value true
if the object exists in live mode or the value false
if the object exists in test mode.
ID of the PaymentIntent that's disputed.
Reason given by cardholder for dispute. Possible values are bank_cannot_process
, check_returned
, credit_not_processed
, customer_initiated
, debit_not_authorized
, duplicate
, fraudulent
, general
, incorrect_account_details
, insufficient_funds
, product_not_received
, product_unacceptable
, subscription_canceled
, or unrecognized
. Learn more about dispute reasons.
Current status of dispute. Possible values are warning_needs_response
, warning_under_review
, warning_closed
, needs_response
, under_review
, won
, or lost
.
stripeError
object
stripePaymentIntent
object
Unique identifier for the object.
last_payment_error
object
The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
Has the value true
if the object exists in live mode or the value false
if the object exists in test mode.
Possible values: [requires_payment_method
, requires_confirmation
, requires_action
, processing
, requires_capture
, canceled
, succeeded
]
Status of this PaymentIntent. Read more about each PaymentIntent status.
stripeRefund
object
ID of the charge that's refunded.
estinationDetails
object
Transaction-specific details for the refund.
card
object
Value of the reference number assigned to the refund.
Status of the reference number on the refund. This can be pending
, available
or unavailable
.
Type of the reference number assigned to the refund.
The type of refund. This can be refund
, reversal
, or pending
.
The type of transaction-specific details of the payment method used in the refund (e.g., card
). An additional hash is included on destination_details
with a name matching this value. It contains information specific to the refund transaction.
us_bank_transfer
object
The reference assigned to the refund.
Status of the reference on the refund. This can be pending
, available
or unavailable
.
After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
Provides the reason for the refund failure. Possible values are: lost_or_stolen_card
, expired_or_canceled_card
, charge_for_pending_refund_disputed
, insufficient_funds
, declined
, merchant_request
, or unknown
.
ID of the PaymentIntent that's refunded.
Possible values: [pending
, requires_action
, succeeded
, failed
, canceled
]
Status of the refund. This can be pending
, requires_action
, succeeded
, failed
, or canceled
. Learn more about failed refunds.
Possible values: [``, ADYEN
, ALIBABA
, AWS
, AWS_CHINA
, AZURE
, GCP
, GOOGLE
, HUBSPOT
, LAGO
, MARKETO
, METRONOME
, MICROSOFT
, ORACLE
, ORB
, REDHAT
, SALESFORCE
, SLACK
, STRIPE
, ZOHO
]
Possible values: [PENDING
, PROCESSING
, SUCCESS
, FAILED
]
Possible values: [CHARGE
, REFUND
]
Possible values: [ach_debit
, bacs_debit
, card
, credit
, sepa_debit
]
[
{
"amount": 0,
"buyerID": "string",
"creationTime": "2024-08-12T01:02:14.940Z",
"currency": "string",
"entitlementID": "string",
"id": "string",
"info": {
"invoiceDate": "2024-08-12T01:02:14.940Z",
"refundExists": true,
"stripeBalanceTransaction": {
"amount": 0,
"available_on": 0,
"chargeId": "string",
"created": 0,
"description": "string",
"exchange_rate": 0,
"fee": 0,
"fee_details": [
{
"amount": 0,
"application": "string",
"description": "string",
"type": "string"
}
],
"id": "string",
"net": 0,
"status": "string",
"type": "string"
},
"stripeDisputes": [
{
"amount": 0,
"chargeId": "string",
"created": 0,
"id": "string",
"is_charge_refundable": true,
"livemode": true,
"paymentIntentId": "string",
"reason": "string",
"status": "string"
}
],
"stripeError": {
"code": "string",
"message": "string",
"param": "string",
"status": 0,
"type": "string"
},
"stripePaymentIntent": {
"id": "string",
"last_payment_error": {
"code": "string",
"message": "string",
"param": "string",
"status": 0,
"type": "string"
},
"livemode": true,
"status": "requires_payment_method"
},
"stripeRefund": {
"chargeId": "string",
"estinationDetails": {
"card": {
"reference": "string",
"reference_status": "string",
"reference_type": "string",
"type": "string"
},
"type": "string",
"us_bank_transfer": {
"reference": "string",
"reference_status": "string"
}
},
"failureBalanceTransactionId": "string",
"failureReason": "string",
"id": "string",
"paymentIntentId": "string",
"status": "pending"
}
},
"invoiceID": "string",
"lastUpdateTime": "2024-08-12T01:02:14.942Z",
"organizationID": "string",
"parentID": "string",
"partner": "",
"status": "PENDING",
"type": "CHARGE",
"walletID": "string",
"walletType": "ach_debit"
}
]
Bad request error
- application/json
- Schema
Schema
string
Internal server error
- application/json
- Schema
Schema
string