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}
Refund a test-mode transaction Test helper
Refund a test-mode Transaction.
Parameters
- refund_
amountinteger 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.
Returns
A Transaction
object. This will be the Transaction
object of type capture
referenced in the request’s URL, not the new Transaction
object of type refund
that will be created as a side-effect of this API call. To find the newly created Transaction
object, you can use the Retrieve an authorization API, whose response will contain a list of related Transaction
IDs, including the newly created Transaction
of type refund
. You can also use the List all transactions API, or listen for the issuing_
webhook event to retrieve the newly created Transaction
of type refund
.
{ "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}
A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
Related guide: Fleet management
A Location represents a grouping of readers.
Related guide: Fleet management