Retrieve a transaction
Retrieves an Issuing Transaction
object.
Parameters
No parameters.
Returns
Returns an Issuing Transaction
object if a valid identifier was provided.
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
- 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_after
. Each entry in the array is a separate Issuing Transaction
object. If no more transactions are available, the resulting array will be empty.
Create a test-mode force captureTest 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
Create a test-mode unlinked refundTest 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
Refund a test-mode transactionTest 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_transaction.created
webhook event to retrieve the newly created Transaction
of type refund
.