The Transaction object
Attributes
- id string Unique identifier for the object.
- amount integer The transaction amount, which will be reflected in your balance. This amount is in your currency and in the smallest currency unit.
- authorization nullable string Expandable The
Authorizationobject that led to this transaction. - card string Expandable The card used to make this transaction.
- cardholder nullable string Expandable The cardholder to whom this transaction belongs.
- currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
- metadata map 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.
- type enum The nature of the transaction. Possible enum values
captureFunds were captured by the acquirer.amountwill be negative because funds are moving out of your balance. Not all captures will be linked to an authorization, as acquirers can force capture in some cases.refundAn acquirer initiated a refund. This transaction might not be linked to an original capture, for example credits are original transactions.amountwill be positive for refunds and negative for refund reversals. Refund reversals occur when a previous refund needs to be reversed, typically due to duplicate refunds. Learn more about refund reversals.
More attributes
- object string, value is "issuing.transaction"
- amount _ details nullable object
- balance _ transaction nullable string Expandable
- created timestamp
- dispute nullable string Expandable
- livemode boolean
- merchant _ amount integer
- merchant _ currency enum
- merchant _ data object
- network _ data nullable object
- purchase _ details nullable object Includable
- token nullable string Preview feature Expandable
- wallet nullable enum
The Transaction object
{ "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
POST / v1 / issuing / transactions /:id
Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- metadata map 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.
Response
{ "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
GET / v1 / issuing / transactions /:id
Retrieves an Issuing Transaction object.
Parameters
No parameters.
Returns
Returns an Issuing Transaction object if a valid identifier was provided.
Response
{ "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}
