Transactions
Any use of an issued card that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is represented by an Issuing Transaction
object.
Related guide: Issued card transactions
The Transaction object
Attributes
- idstring
Unique identifier for the object.
- amountinteger
The transaction amount, which will be reflected in your balance. This amount is in your currency and in the smallest currency unit.
- authorizationnullable stringExpandable
The
Authorization
object that led to this transaction. - cardstringExpandable
The card used to make this transaction.
- cardholdernullable stringExpandable
The cardholder to whom this transaction belongs.
- currencyenum
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- metadatadictionary
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- typeenum
The nature of the transaction.
Possible enum valuescapture
Funds were captured by the acquirer.
amount
will be negative as funds are moving out of your balance. Not all captures will be linked to an authorization, as acquirers can force capture in some cases.refund
An acquirer initiated a refund. This transaction might not be linked to an original capture, for example credits are original transactions.
amount
will be positive for refunds and negative for refund reversals (very rare).
More attributes
- objectstring
- amount_
detailsnullable dictionary - balance_
transactionnullable stringExpandable - createdtimestamp
- disputenullable stringExpandable
- livemodeboolean
- merchant_
amountinteger - merchant_
currencyenum - merchant_
datadictionary - network_
datanullable dictionary - purchase_
detailsnullable dictionaryExpandable - tokennullable stringPreview featureExpandable
- walletnullable enum
{
"id": "ipi_1MzFN1K8F4fqH0lBmFq8CjbU",
"object": "issuing.transaction",
"amount": -100,
"amount_details": {
"atm_fee": null
},
"authorization": "iauth_1MzFMzK8F4fqH0lBc9VdaZUp",
"balance_transaction": "txn_1MzFN1K8F4fqH0lBQPtqUmJN",
"card": "ic_1MzFMxK8F4fqH0lBjIUITRYi",
"cardholder": "ich_1MzFMxK8F4fqH0lBXnFW0ROG",
"created": 1682065867,
"currency": "usd",
"dispute": null,
"livemode": false,
"merchant_amount": -100,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "WWWW.BROWSEBUG.BIZ",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {},
"type": "capture",
"wallet": null
}
Update a transaction
Updates the specified Issuing Transaction
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- metadatadictionary
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
Returns
Returns an updated Issuing Transaction
object if a valid identifier was provided.
{
"id": "ipi_1MzFN1K8F4fqH0lBmFq8CjbU",
"object": "issuing.transaction",
"amount": -100,
"amount_details": {
"atm_fee": null
},
"authorization": "iauth_1MzFMzK8F4fqH0lBc9VdaZUp",
"balance_transaction": "txn_1MzFN1K8F4fqH0lBQPtqUmJN",
"card": "ic_1MzFMxK8F4fqH0lBjIUITRYi",
"cardholder": "ich_1MzFMxK8F4fqH0lBXnFW0ROG",
"created": 1682065867,
"currency": "usd",
"dispute": null,
"livemode": false,
"merchant_amount": -100,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "WWWW.BROWSEBUG.BIZ",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {
"order_id": "6735"
},
"type": "capture",
"wallet": null
}
Retrieve a transaction
Retrieves an Issuing Transaction
object.
Parameters
No parameters.
Returns
Returns an Issuing Transaction
object if a valid identifier was provided.
{
"id": "ipi_1MzFN1K8F4fqH0lBmFq8CjbU",
"object": "issuing.transaction",
"amount": -100,
"amount_details": {
"atm_fee": null
},
"authorization": "iauth_1MzFMzK8F4fqH0lBc9VdaZUp",
"balance_transaction": "txn_1MzFN1K8F4fqH0lBQPtqUmJN",
"card": "ic_1MzFMxK8F4fqH0lBjIUITRYi",
"cardholder": "ich_1MzFMxK8F4fqH0lBXnFW0ROG",
"created": 1682065867,
"currency": "usd",
"dispute": null,
"livemode": false,
"merchant_amount": -100,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "WWWW.BROWSEBUG.BIZ",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {},
"type": "capture",
"wallet": null
}
List all transactions
Returns a list of Issuing Transaction
objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- cardstring
Only return transactions that belong to the given card.
- cardholderstring
Only return transactions that belong to the given cardholder.
More parameters
- createddictionary
- ending_
beforestring - limitinteger
- starting_
afterstring - typeenum
Returns
A dictionary with a data
property that contains an array of up to limit
transactions, starting after transaction starting_after
. Each entry in the array is a separate Issuing Transaction
object. If no more transactions are available, the resulting array will be empty.
{
"object": "list",
"url": "/v1/issuing/transactions",
"has_more": false,
"data": [
{
"id": "ipi_1MzFN1K8F4fqH0lBmFq8CjbU",
"object": "issuing.transaction",
"amount": -100,
"amount_details": {
"atm_fee": null
},
"authorization": "iauth_1MzFMzK8F4fqH0lBc9VdaZUp",
"balance_transaction": "txn_1MzFN1K8F4fqH0lBQPtqUmJN",
"card": "ic_1MzFMxK8F4fqH0lBjIUITRYi",
"cardholder": "ich_1MzFMxK8F4fqH0lBXnFW0ROG",
"created": 1682065867,
"currency": "usd",
"dispute": null,
"livemode": false,
"merchant_amount": -100,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "WWWW.BROWSEBUG.BIZ",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {},
"type": "capture",
"wallet": null
}
{...}
{...}
],
}