Updates the specified Issuing Transaction
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- metadataobject
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}
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}
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
- createdobject
- 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_
. 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 } ]}
Create a test-mode force capture Test helper
Allows the user to capture an arbitrary amount, also known as a forced capture.
Parameters
- amountintegerRequired
The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the smallest currency unit.
- cardstringRequired
Card associated with this transaction.
- currencyenum
The currency of the capture. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency.
More parameters
- merchant_
dataobject - purchase_
detailsobject
Returns
A Transaction object
{ "id": "ipi_1GswaK2eZvKYlo2Co7wmNJhD", "object": "issuing.transaction", "amount": -1000, "amount_details": { "atm_fee": null, "cashback_amount": null }, "authorization": "iauth_1GswaJ2eZvKYlo2Ct9mFMJ4S", "balance_transaction": "txn_1GswaK2eZvKYlo2CJAFFIuHg", "card": "ic_1Gswa82eZvKYlo2CP2jveFil", "cardholder": "ich_1Gswa82eZvKYlo2CvobneLSo", "created": 1591905672, "currency": "usd", "dispute": null, "livemode": false, "merchant_amount": -1000, "merchant_currency": "usd", "merchant_data": { "category": "computer_software_stores", "category_code": "5734", "city": "SAN FRANCISCO", "country": "US", "name": "STRIPE.COM", "network_id": "1234567890", "postal_code": "94103", "state": "CA", "terminal_id": null }, "metadata": { "order_id": "6735" }, "redaction": null, "type": "capture", "wallet": null}
Create a test-mode unlinked refund Test helper
Allows the user to refund an arbitrary amount, also known as a unlinked refund.
Parameters
- amountintegerRequired
The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the smallest currency unit.
- cardstringRequired
Card associated with this unlinked refund transaction.
- currencyenum
The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency.
More parameters
- merchant_
dataobject - purchase_
detailsobject
Returns
A Transaction object
{ "id": "ipi_1GswaK2eZvKYlo2Co7wmNJhD", "object": "issuing.transaction", "amount": -1000, "amount_details": { "atm_fee": null, "cashback_amount": null }, "authorization": "iauth_1GswaJ2eZvKYlo2Ct9mFMJ4S", "balance_transaction": "txn_1GswaK2eZvKYlo2CJAFFIuHg", "card": "ic_1Gswa82eZvKYlo2CP2jveFil", "cardholder": "ich_1Gswa82eZvKYlo2CvobneLSo", "created": 1591905672, "currency": "usd", "dispute": null, "livemode": false, "merchant_amount": -1000, "merchant_currency": "usd", "merchant_data": { "category": "computer_software_stores", "category_code": "5734", "city": "SAN FRANCISCO", "country": "US", "name": "STRIPE.COM", "network_id": "1234567890", "postal_code": "94103", "state": "CA", "terminal_id": null }, "metadata": { "order_id": "6735" }, "redaction": null, "type": "capture", "wallet": null}