text
stringlengths 129
11.9k
|
|---|
'''The review objectAttributes id string Unique identifier for the object. charge string expandable The charge associated with this review. open boolean If true, the review needs action. payment_intent string expandable The PaymentIntent ID associated with this review, if one exists. reason string The reason the review is currently open or closed. One of rule, manual, approved, refunded, refunded_as_fraud, disputed, or redacted.More attributesExpand all object string, value is "review" billing_zip string closed_reason string created timestamp ip_address string ip_address_location hash livemode boolean opened_reason string session hash
''''''The review object {
"id": "prv_1D5Z7u2eZvKYlo2CJBwIbCtC",
"object": "review",
"billing_zip": null,
"charge": "ch_1D5Z7u2eZvKYlo2C5eRC7CrZ",
"closed_reason": null,
"created": 1535808418,
"ip_address": null,
"ip_address_location": null,
"livemode": false,
"open": true,
"opened_reason": "rule",
"reason": "rule",
"session": null
}
''' |
'''Approve a reviewApproves a Review object, closing it and removing it from the list of reviews.ParametersNo parameters.ReturnsReturns the approved Review object
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.Review.approve(
"prv_1D5Z7u2eZvKYlo2CJBwIbCtC",
)
'''Response {
"id": "prv_1D5Z7u2eZvKYlo2CJBwIbCtC",
"object": "review",
"billing_zip": null,
"charge": "ch_1D5Z7u2eZvKYlo2C5eRC7CrZ",
"closed_reason": null,
"created": 1535808418,
"ip_address": null,
"ip_address_location": null,
"livemode": false,
"open": true,
"opened_reason": "rule",
"reason": "rule",
"session": null
}''' |
'''Retrieve a reviewRetrieves a Review object.ParametersNo parameters.ReturnsReturns a Review object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.Review.retrieve(
"prv_1D5Z7u2eZvKYlo2CJBwIbCtC",
)
'''Response {
"id": "prv_1D5Z7u2eZvKYlo2CJBwIbCtC",
"object": "review",
"billing_zip": null,
"charge": "ch_1D5Z7u2eZvKYlo2C5eRC7CrZ",
"closed_reason": null,
"created": 1535808418,
"ip_address": null,
"ip_address_location": null,
"livemode": false,
"open": true,
"opened_reason": "rule",
"reason": "rule",
"session": null
}''' |
'''List all open reviewsReturns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.ParametersExpand all created optional dictionary ending_before optional limit optional starting_after optional ReturnsA dictionary with a data property that contains an array of up to limit reviews, starting after review starting_after. Each entry in the array is a separate Review object. If no more reviews are available, the resulting array will be empty
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.Review.list(limit=3)
'''Response {
"object": "list",
"url": "/v1/reviews",
"has_more": false,
"data": [
{
"id": "prv_1D5Z7u2eZvKYlo2CJBwIbCtC",
"object": "review",
"billing_zip": null,
"charge": "ch_1D5Z7u2eZvKYlo2C5eRC7CrZ",
"closed_reason": null,
"created": 1535808418,
"ip_address": null,
"ip_address_location": null,
"livemode": false,
"open": true,
"opened_reason": "rule",
"reason": "rule",
"session": null
},
{...},
{...}
]
}''' |
'''Value ListsValue lists allow you to group values together which can then be referenced in rules.
''''''Endpoints POST /v1/radar/value_lists GET /v1/radar/value_lists/:id POST /v1/radar/value_lists/:idDELETE /v1/radar/value_lists/:id GET /v1/radar/value_lists
''' |
'''The value list objectAttributes id string Unique identifier for the object. alias string The name of the value list for use in rules. item_type string The type of items in the value list. One of card_fingerprint, card_bin, email, ip_address, country, string, case_sensitive_string, or customer_id. list_items list List of items contained within this value list.Show child attributes metadata hash 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. name string The name of the value list.More attributesExpand all object string, value is "radar.value_list" created timestamp created_by string livemode boolean
''''''The value list object {
"id": "rsl_1LSe3S2eZvKYlo2C3mKm3N8Z",
"object": "radar.value_list",
"alias": "custom_ip_blocklist",
"created": 1659519594,
"created_by": "jenny@example.com",
"item_type": "ip_address",
"list_items": {
"object": "list",
"data": [],
"has_more": false,
"url": "/v1/radar/value_list_items?value_list=rsl_1LSe3S2eZvKYlo2C3mKm3N8Z"
},
"livemode": false,
"metadata": {},
"name": "Custom IP Blocklist"
}
''' |
'''Create a value listCreates a new ValueList object, which can then be referenced in rules.Parameters alias required The name of the value list for use in rules. name required The human-readable name of the value list. item_type optional Type of the items in the value list. One of card_fingerprint, card_bin, email, ip_address, country, string, case_sensitive_string, or customer_id. Use string if the item type is unknown or mixed. metadata optional dictionary 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.ReturnsReturns a ValueList object if creation succeeds
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.radar.ValueList.create(
alias="custom_ip_blocklist",
name="Custom IP Blocklist",
item_type="ip_address",
)
'''Response {
"id": "rsl_1LSe3S2eZvKYlo2C3mKm3N8Z",
"object": "radar.value_list",
"alias": "custom_ip_blocklist",
"created": 1659519594,
"created_by": "jenny@example.com",
"item_type": "ip_address",
"list_items": {
"object": "list",
"data": [],
"has_more": false,
"url": "/v1/radar/value_list_items?value_list=rsl_1LSe3S2eZvKYlo2C3mKm3N8Z"
},
"livemode": false,
"metadata": {},
"name": "Custom IP Blocklist"
}''' |
'''Retrieve a value listRetrieves a ValueList object.ParametersNo parameters.ReturnsReturns a ValueList object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.radar.ValueList.retrieve(
"rsl_1LSe3S2eZvKYlo2C3mKm3N8Z",
)
'''Response {
"id": "rsl_1LSe3S2eZvKYlo2C3mKm3N8Z",
"object": "radar.value_list",
"alias": "custom_ip_blocklist",
"created": 1659519594,
"created_by": "jenny@example.com",
"item_type": "ip_address",
"list_items": {
"object": "list",
"data": [],
"has_more": false,
"url": "/v1/radar/value_list_items?value_list=rsl_1LSe3S2eZvKYlo2C3mKm3N8Z"
},
"livemode": false,
"metadata": {},
"name": "Custom IP Blocklist"
}''' |
'''Update a value listUpdates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.Parameters alias optional The name of the value list for use in rules. metadata optional dictionary 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. name optional The human-readable name of the value list.ReturnsReturns an updated ValueList object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.radar.ValueList.modify(
"rsl_1LSe3S2eZvKYlo2C3mKm3N8Z",
name="Updated IP Block List",
)
'''Response {
"id": "rsl_1LSe3S2eZvKYlo2C3mKm3N8Z",
"object": "radar.value_list",
"alias": "custom_ip_blocklist",
"created": 1659519594,
"created_by": "jenny@example.com",
"item_type": "ip_address",
"list_items": {
"object": "list",
"data": [],
"has_more": false,
"url": "/v1/radar/value_list_items?value_list=rsl_1LSe3S2eZvKYlo2C3mKm3N8Z"
},
"livemode": false,
"metadata": {},
"name": "Updated IP Blocklist",
"updated": 1659519597,
"updated_by": "jenny@example.com"
}''' |
'''Delete a value listDeletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.ParametersNo parameters.ReturnsReturns an object with the deleted ValueList object’s ID and a deleted parameter on success. Otherwise, this call raises an error
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.radar.ValueList.delete(
"rsl_1LSe3S2eZvKYlo2C3mKm3N8Z",
)
'''Response {
"id": "rsl_1LSe3S2eZvKYlo2C3mKm3N8Z",
"object": "radar.value_list",
"deleted": true
}''' |
'''List all value listsReturns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.Parameters alias optional The alias used to reference the value list when writing rules.More parametersExpand all contains optional created optional dictionary ending_before optional limit optional starting_after optional ReturnsA dictionary with a data property that contains an array of up to limit lists, starting after list starting_after. Each entry in the array is a separate ValueList object. If no more lists are available, the resulting array will be empty
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.radar.ValueList.list(limit=3)
'''Response {
"object": "list",
"url": "/v1/radar/value_lists",
"has_more": false,
"data": [
{
"id": "rsl_1LSe3S2eZvKYlo2C3mKm3N8Z",
"object": "radar.value_list",
"alias": "custom_ip_blocklist",
"created": 1659519594,
"created_by": "jenny@example.com",
"item_type": "ip_address",
"list_items": {
"object": "list",
"data": [],
"has_more": false,
"url": "/v1/radar/value_list_items?value_list=rsl_1LSe3S2eZvKYlo2C3mKm3N8Z"
},
"livemode": false,
"metadata": {},
"name": "Custom IP Blocklist"
},
{...},
{...}
]
}''' |
'''Value List ItemsValue list items allow you to add specific values to a given Radar value list, which can then be used in rules.
''''''Endpoints POST /v1/radar/value_list_items GET /v1/radar/value_list_items/:idDELETE /v1/radar/value_list_items/:id GET /v1/radar/value_list_items
''' |
'''The value list item objectAttributes id string Unique identifier for the object. value string The value of the item. value_list string The identifier of the value list this item belongs to.More attributesExpand all object string, value is "radar.value_list_item" created timestamp created_by string livemode boolean
''''''The value list item object {
"id": "rsli_1LSdro2eZvKYlo2Cv5zBtwbD",
"object": "radar.value_list_item",
"created": 1659518872,
"created_by": "jenny@example.com",
"livemode": false,
"value": "1.2.3.4",
"value_list": "rsl_1LSdro2eZvKYlo2C40UDoADG"
}
''' |
'''Create a value list itemCreates a new ValueListItem object, which is added to the specified parent value list.Parameters value required The value of the item (whose type must match the type of the parent value list). value_list required The identifier of the value list which the created item will be added to.ReturnsReturns a ValueListItem object if creation succeeds
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.radar.ValueListItem.create(
value_list="rsl_1LSdro2eZvKYlo2C9T0dzYHM",
value="1.2.3.4",
)
'''Response {
"id": "rsli_1LSdro2eZvKYlo2Cv5zBtwbD",
"object": "radar.value_list_item",
"created": 1659518872,
"created_by": "jenny@example.com",
"livemode": false,
"value": "1.2.3.4",
"value_list": "rsl_1LSdro2eZvKYlo2C9T0dzYHM"
}''' |
'''Retrieve a value list itemRetrieves a ValueListItem object.ParametersNo parameters.ReturnsReturns a ValueListItem object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.radar.ValueListItem.retrieve(
"rsli_1LSdro2eZvKYlo2Cv5zBtwbD",
)
'''Response {
"id": "rsli_1LSdro2eZvKYlo2Cv5zBtwbD",
"object": "radar.value_list_item",
"created": 1659518872,
"created_by": "jenny@example.com",
"livemode": false,
"value": "1.2.3.4",
"value_list": "rsl_1LSdro2eZvKYlo2C40UDoADG"
}''' |
'''Delete a value list itemDeletes a ValueListItem object, removing it from its parent value list.ParametersNo parameters.ReturnsReturns an object with the deleted ValueListItem object’s ID and a deleted parameter on success. Otherwise, this call raises an error
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.radar.ValueListItem.delete(
"rsli_1LSdro2eZvKYlo2Cv5zBtwbD",
)
'''Response {
"id": "rsli_1LSdro2eZvKYlo2Cv5zBtwbD",
"object": "radar.value_list_item",
"deleted": true
}''' |
'''List all value list itemsReturns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.Parameters value_list required Identifier for the parent value list this item belongs to. value optional Return items belonging to the parent list whose value matches the specified value (using an “is like” match).More parametersExpand all created optional dictionary ending_before optional limit optional starting_after optional ReturnsA dictionary with a data property that contains an array of up to limit items, starting after item starting_after. Each entry in the array is a separate ValueListItem object. If no more items are available, the resulting array will be empty
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.radar.ValueListItem.list(
limit=3,
value_list="rsl_1LSdro2eZvKYlo2C9T0dzYHM",
)
'''Response {
"object": "list",
"url": "/v1/radar/value_list_items",
"has_more": false,
"data": [
{
"id": "rsli_1LSdro2eZvKYlo2Cv5zBtwbD",
"object": "radar.value_list_item",
"created": 1659518872,
"created_by": "jenny@example.com",
"livemode": false,
"value": "1.2.3.4",
"value_list": "rsl_1LSdro2eZvKYlo2C40UDoADG"
},
{...},
{...}
]
}''' |
'''AuthorizationsWhen an issued card is used to make a purchase, an Issuing Authorization
object is created. Authorizations must be approved for the
purchase to be completed successfully.
''''''Endpoints GET /v1/issuing/authorizations/:id POST /v1/issuing/authorizations/:id POST /v1/issuing/authorizations/:id/approve POST /v1/issuing/authorizations/:id/decline GET /v1/issuing/authorizations
''' |
'''The Authorization objectAttributes id string Unique identifier for the object. amount integer The total amount that was authorized or rejected. This amount is in the card’s currency and in the smallest currency unit. approved boolean Whether the authorization has been approved. card hash, issuing.card object Card associated with this authorization. cardholder string expandable The cardholder to whom this authorization belongs. currency currency Three-letter ISO currency code, in lowercase. Must be a supported currency. metadata hash 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. status enum The current status of the authorization in its lifecycle.Possible enum valuespending The authorization was created and is awaiting approval or was approved and is awaiting capture.closed The authorization was declined or captured through one or more transactions.reversed The authorization was reversed by the merchant or expired without capture.More attributesExpand all object string, value is "issuing.authorization" amount_details hash authorization_method enum balance_transactions array, contains: balance_transaction object created timestamp livemode boolean merchant_amount integer merchant_currency currency merchant_data hash pending_request hash request_history array of hashes transactions array, contains: issuing.transaction object verification_data hash wallet string
''''''The Authorization object {
"id": "iauth_1JVXl82eZvKYlo2CPIiWlzrn",
"object": "issuing.authorization",
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"authorization_method": "online",
"balance_transactions": [],
"card": {
"id": "ic_1JDmgz2eZvKYlo2CRXlTsXj6",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1626425119,
"email": "jenny.rosen@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1626425206,
"currency": "usd",
"exp_month": 6,
"exp_year": 2024,
"last4": "8693",
"livemode": false,
"metadata": {},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [
{
"amount": 50000,
"categories": [],
"interval": "daily"
}
],
"spending_limits_currency": "usd"
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": true,
"ineligible_reason": null
},
"primary_account_identifier": null
}
},
"cardholder": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"created": 1630657706,
"currency": "usd",
"livemode": false,
"merchant_amount": 382,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "STRIPE",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {
"order_id": "6735"
},
"pending_request": null,
"redaction": null,
"request_history": [
{
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"created": 1630657706,
"currency": "usd",
"merchant_amount": 382,
"merchant_currency": "usd",
"reason": "verification_failed"
}
],
"status": "closed",
"transactions": [],
"verification_data": {
"address_line1_check": "not_provided",
"address_postal_code_check": "not_provided",
"cvc_check": "mismatch",
"expiry_check": "match"
},
"wallet": null
}
''' |
'''Retrieve an authorizationRetrieves an Issuing Authorization object.ParametersNo parameters.ReturnsReturns an Issuing Authorization object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Authorization.retrieve(
"iauth_1JVXl82eZvKYlo2CPIiWlzrn",
)
'''Response {
"id": "iauth_1JVXl82eZvKYlo2CPIiWlzrn",
"object": "issuing.authorization",
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"authorization_method": "online",
"balance_transactions": [],
"card": {
"id": "ic_1JDmgz2eZvKYlo2CRXlTsXj6",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1626425119,
"email": "jenny.rosen@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1626425206,
"currency": "usd",
"exp_month": 6,
"exp_year": 2024,
"last4": "8693",
"livemode": false,
"metadata": {},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [
{
"amount": 50000,
"categories": [],
"interval": "daily"
}
],
"spending_limits_currency": "usd"
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": true,
"ineligible_reason": null
},
"primary_account_identifier": null
}
},
"cardholder": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"created": 1630657706,
"currency": "usd",
"livemode": false,
"merchant_amount": 382,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "STRIPE",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {
"order_id": "6735"
},
"pending_request": null,
"redaction": null,
"request_history": [
{
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"created": 1630657706,
"currency": "usd",
"merchant_amount": 382,
"merchant_currency": "usd",
"reason": "verification_failed"
}
],
"status": "closed",
"transactions": [],
"verification_data": {
"address_line1_check": "not_provided",
"address_postal_code_check": "not_provided",
"cvc_check": "mismatch",
"expiry_check": "match"
},
"wallet": null
}''' |
'''Update an authorizationUpdates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.Parameters metadata optional dictionary 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.ReturnsReturns an updated Issuing Authorization object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Authorization.modify(
"iauth_1JVXl82eZvKYlo2CPIiWlzrn",
metadata={"order_id": "6735"},
)
'''Response {
"id": "iauth_1JVXl82eZvKYlo2CPIiWlzrn",
"object": "issuing.authorization",
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"authorization_method": "online",
"balance_transactions": [],
"card": {
"id": "ic_1JDmgz2eZvKYlo2CRXlTsXj6",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1626425119,
"email": "jenny.rosen@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1626425206,
"currency": "usd",
"exp_month": 6,
"exp_year": 2024,
"last4": "8693",
"livemode": false,
"metadata": {},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [
{
"amount": 50000,
"categories": [],
"interval": "daily"
}
],
"spending_limits_currency": "usd"
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": true,
"ineligible_reason": null
},
"primary_account_identifier": null
}
},
"cardholder": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"created": 1630657706,
"currency": "usd",
"livemode": false,
"merchant_amount": 382,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "STRIPE",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {
"order_id": "6735"
},
"pending_request": null,
"redaction": null,
"request_history": [
{
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"created": 1630657706,
"currency": "usd",
"merchant_amount": 382,
"merchant_currency": "usd",
"reason": "verification_failed"
}
],
"status": "closed",
"transactions": [],
"verification_data": {
"address_line1_check": "not_provided",
"address_postal_code_check": "not_provided",
"cvc_check": "mismatch",
"expiry_check": "match"
},
"wallet": null
}''' |
'''Approve an authorizationApproves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.Parameters amount optional If the authorization’s pending_request.is_amount_controllable property is true, you may provide this value to control how much to hold for the authorization. Must be positive (use decline to decline an authorization request). metadata optional dictionary 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.ReturnsReturns an approved Issuing Authorization object
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Authorization.approve(
"iauth_1JVXl82eZvKYlo2CPIiWlzrn",
)
'''Response {
"id": "iauth_1JVXl82eZvKYlo2CPIiWlzrn",
"object": "issuing.authorization",
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"authorization_method": "online",
"balance_transactions": [],
"card": {
"id": "ic_1JDmgz2eZvKYlo2CRXlTsXj6",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1626425119,
"email": "jenny.rosen@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1626425206,
"currency": "usd",
"exp_month": 6,
"exp_year": 2024,
"last4": "8693",
"livemode": false,
"metadata": {},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [
{
"amount": 50000,
"categories": [],
"interval": "daily"
}
],
"spending_limits_currency": "usd"
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": true,
"ineligible_reason": null
},
"primary_account_identifier": null
}
},
"cardholder": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"created": 1630657706,
"currency": "usd",
"livemode": false,
"merchant_amount": 382,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "STRIPE",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {
"order_id": "6735"
},
"pending_request": null,
"redaction": null,
"request_history": [
{
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"created": 1630657706,
"currency": "usd",
"merchant_amount": 382,
"merchant_currency": "usd",
"reason": "verification_failed"
}
],
"status": "closed",
"transactions": [],
"verification_data": {
"address_line1_check": "not_provided",
"address_postal_code_check": "not_provided",
"cvc_check": "mismatch",
"expiry_check": "match"
},
"wallet": null
}''' |
'''Decline an authorizationDeclines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.Parameters metadata optional dictionary 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.ReturnsReturns a declined Issuing Authorization object
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Authorization.decline(
"iauth_1JVXl82eZvKYlo2CPIiWlzrn",
)
'''Response {
"id": "iauth_1JVXl82eZvKYlo2CPIiWlzrn",
"object": "issuing.authorization",
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"authorization_method": "online",
"balance_transactions": [],
"card": {
"id": "ic_1JDmgz2eZvKYlo2CRXlTsXj6",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1626425119,
"email": "jenny.rosen@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1626425206,
"currency": "usd",
"exp_month": 6,
"exp_year": 2024,
"last4": "8693",
"livemode": false,
"metadata": {},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [
{
"amount": 50000,
"categories": [],
"interval": "daily"
}
],
"spending_limits_currency": "usd"
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": true,
"ineligible_reason": null
},
"primary_account_identifier": null
}
},
"cardholder": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"created": 1630657706,
"currency": "usd",
"livemode": false,
"merchant_amount": 382,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "STRIPE",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {
"order_id": "6735"
},
"pending_request": null,
"redaction": null,
"request_history": [
{
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"created": 1630657706,
"currency": "usd",
"merchant_amount": 382,
"merchant_currency": "usd",
"reason": "verification_failed"
}
],
"status": "closed",
"transactions": [],
"verification_data": {
"address_line1_check": "not_provided",
"address_postal_code_check": "not_provided",
"cvc_check": "mismatch",
"expiry_check": "match"
},
"wallet": null
}''' |
'''List all authorizationsReturns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.Parameters card optional Only return authorizations that belong to the given card. cardholder optional Only return authorizations that belong to the given cardholder. status optional Only return authorizations with the given status. One of pending, closed, or reversed.More parametersExpand all created optional dictionary ending_before optional limit optional starting_after optional ReturnsA dictionary with a data property that contains an array of up to limit authorizations, starting after authorization starting_after. Each entry in the array is a separate Issuing Authorization object. If no more authorizations are available, the resulting array will be empty
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Authorization.list(limit=3)
'''Response {
"object": "list",
"url": "/v1/issuing/authorizations",
"has_more": false,
"data": [
{
"id": "iauth_1JVXl82eZvKYlo2CPIiWlzrn",
"object": "issuing.authorization",
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"authorization_method": "online",
"balance_transactions": [],
"card": {
"id": "ic_1JDmgz2eZvKYlo2CRXlTsXj6",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1626425119,
"email": "jenny.rosen@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1626425206,
"currency": "usd",
"exp_month": 6,
"exp_year": 2024,
"last4": "8693",
"livemode": false,
"metadata": {},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [
{
"amount": 50000,
"categories": [],
"interval": "daily"
}
],
"spending_limits_currency": "usd"
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": true,
"ineligible_reason": null
},
"primary_account_identifier": null
}
},
"cardholder": "ich_1JDmfb2eZvKYlo2CwHUgaAxU",
"created": 1630657706,
"currency": "usd",
"livemode": false,
"merchant_amount": 382,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "STRIPE",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {
"order_id": "6735"
},
"pending_request": null,
"redaction": null,
"request_history": [
{
"amount": 382,
"amount_details": {
"atm_fee": null
},
"approved": false,
"created": 1630657706,
"currency": "usd",
"merchant_amount": 382,
"merchant_currency": "usd",
"reason": "verification_failed"
}
],
"status": "closed",
"transactions": [],
"verification_data": {
"address_line1_check": "not_provided",
"address_postal_code_check": "not_provided",
"cvc_check": "mismatch",
"expiry_check": "match"
},
"wallet": null
},
{...},
{...}
]
}''' |
'''CardholdersAn Issuing Cardholder object represents an individual or business entity who is issued cards.
''''''Endpoints POST /v1/issuing/cardholders GET /v1/issuing/cardholders/:id POST /v1/issuing/cardholders/:id GET /v1/issuing/cardholders
''' |
'''The Cardholder objectAttributes id string Unique identifier for the object. billing hash The cardholder’s billing information.Show child attributes email string The cardholder’s email address. metadata hash 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. name string The cardholder’s name. This will be printed on cards issued to them. phone_number string The cardholder’s phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details. type enum One of individual or company.Possible enum valuesindividual The cardholder is a person, and additional information include first and last name, date of birth, etc.company The cardholder is a company or business entity, and additional information include their tax ID.More attributesExpand all object string, value is "issuing.cardholder" company hash created timestamp individual hash livemode boolean requirements hash spending_controls hash status enum
''''''The Cardholder object {
"id": "ich_1KwsZz2eZvKYlo2Cz5eys5Kb",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "\"San Francisco\"",
"country": "US",
"line1": "\"1234 Main Street\"",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1651948931,
"email": "adnansami1992sami@gmail.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "\"Jenny Rosen\"",
"phone_number": "+18888675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
}
''' |
'''Create a cardholderCreates a new Issuing Cardholder object that can be issued cards.Parameters billing required The cardholder’s billing address.Show child parameters name required The cardholder’s name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers. type required One of individual or company.Possible enum valuesindividual The cardholder is a person, and additional information include first and last name, date of birth, etc.company The cardholder is a company or business entity, and additional information include their tax ID. email optional The cardholder’s email address. metadata optional dictionary 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. phone_number optional The cardholder’s phone number. This will be transformed to E.164 if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.More parametersExpand all company optional dictionary individual optional dictionary spending_controls optional dictionary status optional enum ReturnsReturns an Issuing Cardholder object if creation succeeds
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Cardholder.create(
type="individual",
name="Jenny Rosen",
email="jenny.rosen@example.com",
phone_number="+18888675309",
billing={
"address": {
"line1": "1234 Main Street",
"city": "San Francisco",
"state": "CA",
"country": "US",
"postal_code": "94111",
},
},
)
'''Response {
"id": "ich_1KwsZz2eZvKYlo2Cz5eys5Kb",
"object": "issuing.cardholder",
"billing": {
"address": {
"line1": "1234 Main Street",
"city": "San Francisco",
"state": "CA",
"country": "US",
"postal_code": "94111"
}
},
"company": null,
"created": 1651948931,
"email": "jenny.rosen@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18888675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
}''' |
'''Retrieve a cardholderRetrieves an Issuing Cardholder object.ParametersNo parameters.ReturnsReturns an Issuing Cardholder object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Cardholder.retrieve(
"ich_1KwsZz2eZvKYlo2Cz5eys5Kb",
)
'''Response {
"id": "ich_1KwsZz2eZvKYlo2Cz5eys5Kb",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "\"San Francisco\"",
"country": "US",
"line1": "\"1234 Main Street\"",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1651948931,
"email": "adnansami1992sami@gmail.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "\"Jenny Rosen\"",
"phone_number": "+18888675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
}''' |
'''Update a cardholderUpdates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.Parameters billing optional dictionary The cardholder’s billing address.Show child parameters email optional The cardholder’s email address. metadata optional dictionary 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. phone_number optional The cardholder’s phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.More parametersExpand all company optional dictionary individual optional dictionary spending_controls optional dictionary status optional enum ReturnsReturns an updated Issuing Cardholder object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Cardholder.modify(
"ich_1KwsZz2eZvKYlo2Cz5eys5Kb",
metadata={"order_id": "6735"},
)
'''Response {
"id": "ich_1KwsZz2eZvKYlo2Cz5eys5Kb",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "\"San Francisco\"",
"country": "US",
"line1": "\"1234 Main Street\"",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1651948931,
"email": "adnansami1992sami@gmail.com",
"individual": null,
"livemode": false,
"metadata": {
"order_id": "6735"
},
"name": "\"Jenny Rosen\"",
"phone_number": "+18888675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
}''' |
'''List all cardholdersReturns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.ParametersExpand all created optional dictionary email optional ending_before optional limit optional phone_number optional starting_after optional status optional enum type optional enum ReturnsA dictionary with a data property that contains an array of up to limit cardholders, starting after cardholder starting_after. Each entry in the array is a separate Issuing Cardholder object. If no more cardholders are available, the resulting array will be empty
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Cardholder.list(limit=3)
'''Response {
"object": "list",
"url": "/v1/issuing/cardholders",
"has_more": false,
"data": [
{
"id": "ich_1KwsZz2eZvKYlo2Cz5eys5Kb",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "\"San Francisco\"",
"country": "US",
"line1": "\"1234 Main Street\"",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1651948931,
"email": "adnansami1992sami@gmail.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "\"Jenny Rosen\"",
"phone_number": "+18888675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
{...},
{...}
]
}''' |
'''CardsYou can create physical or virtual cards that are issued to cardholders
''''''Endpoints POST /v1/issuing/cards GET /v1/issuing/cards/:id POST /v1/issuing/cards/:id GET /v1/issuing/cards
''' |
'''The Card objectAttributes id string Unique identifier for the object. cancellation_reason enum The reason why the card was canceled.Possible enum valueslost The card was lost.stolen The card was stolen.design_rejected The design of this card was rejected by Stripe for violating our partner guidelines. cardholder hash, issuing.cardholder object The Cardholder object to which the card belongs. currency currency Three-letter ISO currency code, in lowercase. Supported currencies are usd in the US, eur in the EU, and gbp in the UK. exp_month integer The expiration month of the card. exp_year integer The expiration year of the card. last4 string The last 4 digits of the card number. metadata hash 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. status enum Whether authorizations can be approved on this card.Possible enum valuesactive The card can approve authorizations.inactive The card will decline authorizations with the card_inactive reason.canceled The card will decline authorization, and no authorization object will be recorded. This status is permanent. type enum The type of the card.Possible enum valuesphysical A physical card will be printed and shipped. It can be used at physical terminals.virtual No physical card will be printed. The card can be used online and can be added to digital wallets.More attributesExpand all object string, value is "issuing.card" brand string created timestamp cvc string expandable livemode boolean number string expandable replaced_by string expandable replacement_for string expandable replacement_reason enum shipping hash spending_controls hash wallets hash
''''''The Card object {
"id": "ic_1LPMCr2eZvKYlo2CELh8Lw2B",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1LPMCG2eZvKYlo2CwrVVYctD",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1658735964,
"email": "jenny.rosen@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1658736001,
"currency": "usd",
"exp_month": 6,
"exp_year": 2025,
"last4": "9592",
"livemode": false,
"metadata": {},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [
{
"amount": 50000,
"categories": [],
"interval": "daily"
}
],
"spending_limits_currency": "usd"
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": true,
"ineligible_reason": null
},
"primary_account_identifier": null
}
}
''' |
'''Create a cardCreates an Issuing Card object.Parameters cardholder required The Cardholder object with which the card will be associated. currency required The currency for the card. type required The type of card to issue. Possible values are physical or virtual.Possible enum valuesphysical A physical card will be printed and shipped. It can be used at physical terminals.virtual No physical card will be printed. The card can be used online and can be added to digital wallets. metadata optional dictionary 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. status optional enum Whether authorizations can be approved on this card. Defaults to inactive.Possible enum valuesactive The card can approve authorizations.inactive The card will decline authorizations with the card_inactive reason.More parametersExpand all replacement_for optional replacement_reason optional enum shipping optional dictionary spending_controls optional dictionary ReturnsReturns an Issuing Card object if creation succeeds
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Card.create(
cardholder="ich_1KwsZz2eZvKYlo2Cz5eys5Kb",
currency="usd",
type="virtual",
)
'''Response {
"id": "ic_1LPMCr2eZvKYlo2CELh8Lw2B",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": "ich_1KwsZz2eZvKYlo2Cz5eys5Kb",
"created": 1658736001,
"currency": "usd",
"exp_month": 6,
"exp_year": 2025,
"last4": "9592",
"livemode": false,
"metadata": {},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [
{
"amount": 50000,
"categories": [],
"interval": "daily"
}
],
"spending_limits_currency": "usd"
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": true,
"ineligible_reason": null
},
"primary_account_identifier": null
}
}''' |
'''Retrieve a cardRetrieves an Issuing Card object.ParametersNo parameters.ReturnsReturns an Issuing Card object if a valid identifier was provided. When requesting the ID of a card that has been deleted, a subset of the card’s information will be returned, including a deleted property, which will be true
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Card.retrieve(
"ic_1LPMCr2eZvKYlo2CELh8Lw2B",
)
'''Response {
"id": "ic_1LPMCr2eZvKYlo2CELh8Lw2B",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1LPMCG2eZvKYlo2CwrVVYctD",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1658735964,
"email": "jenny.rosen@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1658736001,
"currency": "usd",
"exp_month": 6,
"exp_year": 2025,
"last4": "9592",
"livemode": false,
"metadata": {},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [
{
"amount": 50000,
"categories": [],
"interval": "daily"
}
],
"spending_limits_currency": "usd"
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": true,
"ineligible_reason": null
},
"primary_account_identifier": null
}
}''' |
'''Update a cardUpdates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.Parameters cancellation_reason optional enum Reason why the status of this card is canceled.Possible enum valueslost The card was lost.stolen The card was stolen. metadata optional dictionary 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. status optional enum Dictates whether authorizations can be approved on this card. If this card is being canceled because it was lost or stolen, this information should be provided as cancellation_reason.Possible enum valuesactive The card can approve authorizations.inactive The card will decline authorizations with the card_inactive reason.canceled The card will decline authorization, and no authorization object will be recorded. This status is permanent.More parametersExpand all pin optional dictionary spending_controls optional dictionary ReturnsReturns an updated Issuing Card object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Card.modify(
"ic_1LPMCr2eZvKYlo2CELh8Lw2B",
metadata={"order_id": "6735"},
)
'''Response {
"id": "ic_1LPMCr2eZvKYlo2CELh8Lw2B",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1LPMCG2eZvKYlo2CwrVVYctD",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1658735964,
"email": "jenny.rosen@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1658736001,
"currency": "usd",
"exp_month": 6,
"exp_year": 2025,
"last4": "9592",
"livemode": false,
"metadata": {
"order_id": "6735"
},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [
{
"amount": 50000,
"categories": [],
"interval": "daily"
}
],
"spending_limits_currency": "usd"
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": true,
"ineligible_reason": null
},
"primary_account_identifier": null
}
}''' |
'''List all cardsReturns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.Parameters cardholder optional Only return cards belonging to the Cardholder with the provided ID. type optional enum Only return cards that have the given type. One of virtual or physical.Possible enum valuesphysical A physical card will be printed and shipped. It can be used at physical terminals.virtual No physical card will be printed. The card can be used online and can be added to digital wallets.More parametersExpand all created optional dictionary ending_before optional exp_month optional exp_year optional last4 optional limit optional starting_after optional status optional enum ReturnsA dictionary with a data property that contains an array of up to limit cards, starting after card starting_after. Each entry in the array is a separate Issuing Card object. If no more cards are available, the resulting array will be empty
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Card.list(limit=3)
'''Response {
"object": "list",
"url": "/v1/issuing/cards",
"has_more": false,
"data": [
{
"id": "ic_1LPMCr2eZvKYlo2CELh8Lw2B",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1LPMCG2eZvKYlo2CwrVVYctD",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "94111",
"state": "CA"
}
},
"company": null,
"created": 1658735964,
"email": "jenny.rosen@example.com",
"individual": null,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"redaction": null,
"requirements": {
"disabled_reason": null,
"past_due": []
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1658736001,
"currency": "usd",
"exp_month": 6,
"exp_year": 2025,
"last4": "9592",
"livemode": false,
"metadata": {},
"redaction": null,
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [
{
"amount": 50000,
"categories": [],
"interval": "daily"
}
],
"spending_limits_currency": "usd"
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": true,
"ineligible_reason": null
},
"google_pay": {
"eligible": true,
"ineligible_reason": null
},
"primary_account_identifier": null
}
},
{...},
{...}
]
}''' |
'''DisputesAs a card issuer, you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.
''''''Endpoints POST /v1/issuing/disputes POST /v1/issuing/disputes/:id/submit GET /v1/issuing/disputes/:id POST /v1/issuing/disputes/:id GET /v1/issuing/disputes
''' |
'''The Dispute objectAttributes id string Unique identifier for the object. amount integer Disputed amount in the card’s currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation). balance_transactions array, contains: balance_transaction object expandable List of balance transactions associated with the dispute. This field is not included by default. To include it in the response, expand the balance_transactions field. currency currency The currency the transaction was made in. evidence hash Evidence for the dispute. Evidence contains exactly two non-null fields: the reason for the dispute and the associated evidence field for the selected reason.Show child attributes metadata hash 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. status enum Current status of the dispute.Possible enum valueswon The dispute is won.lost The dispute is lost.submitted The dispute has been submitted to Stripe.unsubmitted The dispute is pending submission to Stripe.expired The dispute has expired. transaction string expandable The transaction being disputed.More attributesExpand all object string, value is "issuing.dispute" created timestamp livemode boolean
''''''The Dispute object {
"id": "idp_1LSdsz2eZvKYlo2CzYY577wS",
"object": "issuing.dispute",
"amount": 2000,
"created": 1659518945,
"currency": "usd",
"evidence": {
"fraudulent": {
"additional_documentation": null,
"explanation": "Fraud; card reported lost on 08/03/2022"
},
"reason": "fraudulent"
},
"livemode": false,
"metadata": {},
"redaction": null,
"status": "unsubmitted",
"transaction": "ipi_1JIdAl2eZvKYlo2Cfr8US8uB"
}
''' |
'''Create a disputeCreates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.Parameters evidence optional dictionary Evidence provided for the dispute.Show child parameters metadata optional dictionary 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. transaction optional The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use treasury.received_debit.ReturnsReturns an Issuing Dispute object in unsubmitted status if creation succeeds
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Dispute.create(
transaction="ipi_1JIdAl2eZvKYlo2Cfr8US8uB",
evidence={
"reason": "fraudulent",
"fraudulent": {
"explanation": "Purchase was unrecognized.",
},
},
)
'''Response {
"id": "idp_1LSdsz2eZvKYlo2CzYY577wS",
"object": "issuing.dispute",
"amount": 2000,
"created": 1659518945,
"currency": "usd",
"evidence": {
"reason": "fraudulent",
"fraudulent": {
"explanation": "Purchase was unrecognized."
}
},
"livemode": false,
"metadata": {},
"redaction": null,
"status": "unsubmitted",
"transaction": "ipi_1JIdAl2eZvKYlo2Cfr8US8uB"
}''' |
'''Submit a disputeSubmits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.Parameters metadata optional dictionary 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.ReturnsReturns an Issuing Dispute object in submitted status if submission succeeds
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Dispute.submit(
"idp_1LSdsz2eZvKYlo2CzYY577wS",
)
'''Response {
"id": "idp_1LSdsz2eZvKYlo2CzYY577wS",
"object": "issuing.dispute",
"amount": 2000,
"created": 1659518945,
"currency": "usd",
"evidence": {
"fraudulent": {
"additional_documentation": null,
"explanation": "Fraud; card reported lost on 08/03/2022"
},
"reason": "fraudulent"
},
"livemode": false,
"metadata": {},
"redaction": null,
"status": "submitted",
"transaction": "ipi_1JIdAl2eZvKYlo2Cfr8US8uB"
}''' |
'''Retrieve a disputeRetrieves an Issuing Dispute object.ParametersNo parameters.ReturnsReturns an Issuing Dispute object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Dispute.retrieve(
"idp_1LSdsz2eZvKYlo2CzYY577wS",
)
'''Response {
"id": "idp_1LSdsz2eZvKYlo2CzYY577wS",
"object": "issuing.dispute",
"amount": 2000,
"created": 1659518945,
"currency": "usd",
"evidence": {
"fraudulent": {
"additional_documentation": null,
"explanation": "Fraud; card reported lost on 08/03/2022"
},
"reason": "fraudulent"
},
"livemode": false,
"metadata": {},
"redaction": null,
"status": "unsubmitted",
"transaction": "ipi_1JIdAl2eZvKYlo2Cfr8US8uB"
}''' |
'''Update a disputeUpdates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.Parameters evidence optional dictionary Evidence provided for the dispute.Show child parameters metadata optional dictionary 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.ReturnsReturns an updated Issuing Dispute object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Dispute.modify(
"idp_1LSdsz2eZvKYlo2CzYY577wS",
evidence={
"reason": "not_received",
"not_received": {
"expected_at": 1590000000,
"explanation": "",
"product_description": "Baseball cap",
"product_type": "merchandise",
},
},
)
'''Response {
"id": "idp_1LSdsz2eZvKYlo2CzYY577wS",
"object": "issuing.dispute",
"amount": 2000,
"created": 1659518945,
"currency": "usd",
"evidence": {
"reason": "not_received",
"not_received": {
"expected_at": 1590000000,
"explanation": null,
"product_description": "Baseball cap",
"product_type": "merchandise"
}
},
"livemode": false,
"metadata": {},
"redaction": null,
"status": "unsubmitted",
"transaction": "ipi_1JIdAl2eZvKYlo2Cfr8US8uB"
}''' |
'''List all disputesReturns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.Parameters transaction optional Select the Issuing dispute for the given transaction.More parametersExpand all created optional dictionary ending_before optional limit optional starting_after optional status optional enum ReturnsA dictionary with a data property that contains an array of up to limit disputes, starting after dispute starting_after. Each entry in the array is a separate Issuing Dispute object. If no more disputes are available, the resulting array will be empty
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Dispute.list(limit=3)
'''Response {
"object": "list",
"url": "/v1/issuing/disputes",
"has_more": false,
"data": [
{
"id": "idp_1LSdsz2eZvKYlo2CzYY577wS",
"object": "issuing.dispute",
"amount": 2000,
"created": 1659518945,
"currency": "usd",
"evidence": {
"fraudulent": {
"additional_documentation": null,
"explanation": "Fraud; card reported lost on 08/03/2022"
},
"reason": "fraudulent"
},
"livemode": false,
"metadata": {},
"redaction": null,
"status": "unsubmitted",
"transaction": "ipi_1JIdAl2eZvKYlo2Cfr8US8uB"
},
{...},
{...}
]
}''' |
'''Funding InstructionsFunding Instructions contain reusable bank account and routing information. Push funds
to these addresses via bank transfer to top up Issuing Balances
''''''Endpoints POST /v1/issuing/funding_instructions GET /v1/issuing/funding_instructions POST /v1/test_helpers/issuing/fund_balance
''' |
'''The FundingInstruction objectAttributes bank_transfer hash Details to display instructions for initiating a bank transferShow child attributes currency string Three-letter ISO currency code, in lowercase. Must be a supported currency. funding_type enum The funding_type of the returned instructionsPossible enum valuesbank_transfer Use a bank_transfer hash to define the bank transfer typeMore attributesExpand all object string, value is "funding_instructions" livemode boolean
''''''The FundingInstruction object {
"object": "funding_instructions",
"bank_transfer": {
"country": "DE",
"financial_addresses": [
{
"iban": {
"account_holder_name": "Stripe Technology Europe Limited",
"bic": "SXPYDEHH",
"country": "DE",
"iban": "DE00000000000000000001"
},
"supported_networks": [
"sepa"
],
"type": "iban"
}
],
"type": "eu_bank_transfer"
},
"currency": "eur",
"funding_type": "bank_transfer",
"livemode": false
}
''' |
'''Create funding instructionsCreate or retrieve funding instructions for an Issuing balance. If funding instructions don’t yet exist for the account,
we’ll create new funding instructions. If we’ve already created funding instructions for the account, the same
we’ll retrieve the same funding instructions. In other words, we’ll return the same funding instructions each time.Parameters bank_transfer required Additional parameters for bank_transfer funding typesShow child parameters currency required Three-letter ISO currency code, in lowercase. Must be a supported currency. funding_type required The funding_type to get the instructions for.Possible enum valuesbank_transfer Use a bank_transfer hash to define the bank transfer typeReturnsReturns funding instructions for an Issuing balanc
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.FundingInstructions.create(
currency="eur",
funding_type="bank_transfer",
bank_transfer={"type": "eu_bank_transfer"},
)
'''Response {
"object": "funding_instructions",
"bank_transfer": {
"country": "DE",
"financial_addresses": [
{
"iban": {
"account_holder_name": "Stripe Technology Europe Limited",
"bic": "SXPYDEHH",
"country": "DE",
"iban": "DE00000000000000000001"
},
"supported_networks": [
"sepa"
],
"type": "iban"
}
],
"type": "eu_bank_transfer"
},
"currency": "eur",
"funding_type": "bank_transfer",
"livemode": false
}''' |
'''List all funding instructionsRetrieve all applicable funding instructions for an Issuing balance.ParametersExpand all ending_before optional limit optional starting_after optional ReturnsReturns all funding instructions for an Issuing balanc
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.FundingInstructions.list(limit=3)
'''Response {
"object": "list",
"url": "/v1/issuing/funding_instructionss",
"has_more": false,
"data": [
{
"object": "funding_instructions",
"bank_transfer": {
"country": "DE",
"financial_addresses": [
{
"iban": {
"account_holder_name": "Stripe Technology Europe Limited",
"bic": "SXPYDEHH",
"country": "DE",
"iban": "DE00000000000000000001"
},
"supported_networks": [
"sepa"
],
"type": "iban"
}
],
"type": "eu_bank_transfer"
},
"currency": "eur",
"funding_type": "bank_transfer",
"livemode": false
},
{...},
{...}
]
}''' |
'''Simulate a top upSimulates an external bank transfer and adds funds to an Issuing balance.
This method can only be called in test mode.Parameters amount required The amount to top up currency required The currency to top upReturnsReturns testmode funding instructions for an Issuing balanc
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.FundingInstructions.TestHelpers.fund(
"fi_1LSe6U2eZvKYlo2CQw6IsejT",
currency="eur",
amount=4200,
)
'''Response {
"object": "funding_instructions",
"bank_transfer": {
"country": "DE",
"financial_addresses": [
{
"iban": {
"account_holder_name": "Stripe Technology Europe Limited",
"bic": "SXPYDEHH",
"country": "DE",
"iban": "DE00000000000000000001"
},
"supported_networks": [
"sepa"
],
"type": "iban"
}
],
"type": "eu_bank_transfer"
},
"currency": "eur",
"funding_type": "bank_transfer",
"livemode": false
}''' |
'''TransactionsAny 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.
''''''Endpoints GET /v1/issuing/transactions/:id POST /v1/issuing/transactions/:id GET /v1/issuing/transactions
''' |
'''The Transaction objectAttributes 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 string expandable The Authorization object that led to this transaction. card string expandable The card used to make this transaction. cardholder string expandable The cardholder to whom this transaction belongs. currency currency Three-letter ISO currency code, in lowercase. Must be a supported currency. metadata hash 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 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 attributesExpand all object string, value is "issuing.transaction" amount_details hash balance_transaction string expandable created timestamp dispute string expandable livemode boolean merchant_amount integer merchant_currency currency merchant_data hash purchase_details hash expandable wallet enum
''''''The Transaction object {
"id": "ipi_1JIdAl2eZvKYlo2Cfr8US8uB",
"object": "issuing.transaction",
"amount": -2000,
"amount_details": {
"atm_fee": null
},
"authorization": "iauth_1JIdAO2eZvKYlo2CNzjj2lif",
"balance_transaction": "txn_1JIdAm2eZvKYlo2CHfFOwGfr",
"card": "ic_1JId7I2eZvKYlo2CQcSKF8Df",
"cardholder": "ich_1JId712eZvKYlo2C0lXNIoYn",
"created": 1627580251,
"currency": "usd",
"dispute": null,
"livemode": false,
"merchant_amount": -2000,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "STRIPE",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {
"order_id": "6735"
},
"redaction": null,
"type": "capture",
"wallet": null
}
''' |
'''Retrieve a transactionRetrieves an Issuing Transaction object.ParametersNo parameters.ReturnsReturns an Issuing Transaction object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Transaction.retrieve(
"ipi_1JIdAl2eZvKYlo2Cfr8US8uB",
)
'''Response {
"id": "ipi_1JIdAl2eZvKYlo2Cfr8US8uB",
"object": "issuing.transaction",
"amount": -2000,
"amount_details": {
"atm_fee": null
},
"authorization": "iauth_1JIdAO2eZvKYlo2CNzjj2lif",
"balance_transaction": "txn_1JIdAm2eZvKYlo2CHfFOwGfr",
"card": "ic_1JId7I2eZvKYlo2CQcSKF8Df",
"cardholder": "ich_1JId712eZvKYlo2C0lXNIoYn",
"created": 1627580251,
"currency": "usd",
"dispute": null,
"livemode": false,
"merchant_amount": -2000,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "STRIPE",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {
"order_id": "6735"
},
"redaction": null,
"type": "capture",
"wallet": null
}''' |
'''Update a transactionUpdates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.Parameters metadata optional dictionary 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.ReturnsReturns an updated Issuing Transaction object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Transaction.modify(
"ipi_1JIdAl2eZvKYlo2Cfr8US8uB",
metadata={"order_id": "6735"},
)
'''Response {
"id": "ipi_1JIdAl2eZvKYlo2Cfr8US8uB",
"object": "issuing.transaction",
"amount": -2000,
"amount_details": {
"atm_fee": null
},
"authorization": "iauth_1JIdAO2eZvKYlo2CNzjj2lif",
"balance_transaction": "txn_1JIdAm2eZvKYlo2CHfFOwGfr",
"card": "ic_1JId7I2eZvKYlo2CQcSKF8Df",
"cardholder": "ich_1JId712eZvKYlo2C0lXNIoYn",
"created": 1627580251,
"currency": "usd",
"dispute": null,
"livemode": false,
"merchant_amount": -2000,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "STRIPE",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {
"order_id": "6735"
},
"redaction": null,
"type": "capture",
"wallet": null
}''' |
'''List all transactionsReturns 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 card optional Only return transactions that belong to the given card. cardholder optional Only return transactions that belong to the given cardholder.More parametersExpand all created optional dictionary ending_before optional limit optional starting_after optional type optional enum ReturnsA 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
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.issuing.Transaction.list(limit=3)
'''Response {
"object": "list",
"url": "/v1/issuing/transactions",
"has_more": false,
"data": [
{
"id": "ipi_1JIdAl2eZvKYlo2Cfr8US8uB",
"object": "issuing.transaction",
"amount": -2000,
"amount_details": {
"atm_fee": null
},
"authorization": "iauth_1JIdAO2eZvKYlo2CNzjj2lif",
"balance_transaction": "txn_1JIdAm2eZvKYlo2CHfFOwGfr",
"card": "ic_1JId7I2eZvKYlo2CQcSKF8Df",
"cardholder": "ich_1JId712eZvKYlo2C0lXNIoYn",
"created": 1627580251,
"currency": "usd",
"dispute": null,
"livemode": false,
"merchant_amount": -2000,
"merchant_currency": "usd",
"merchant_data": {
"category": "computer_software_stores",
"category_code": "5734",
"city": "SAN FRANCISCO",
"country": "US",
"name": "STRIPE",
"network_id": "1234567890",
"postal_code": "94103",
"state": "CA"
},
"metadata": {
"order_id": "6735"
},
"redaction": null,
"type": "capture",
"wallet": null
},
{...},
{...}
]
}''' |
'''Connection TokenA Connection Token is used by the Stripe Terminal SDK to connect to a reader.
''''''Endpoints POST /v1/terminal/connection_tokens
''' |
'''The connection token objectAttributes location string The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see the docs on scoping connection tokens. secret string Your application should pass this token to the Stripe Terminal SDK.More attributesExpand all object string, value is "terminal.connection_token"
''''''The connection token object {
"object": "terminal.connection_token",
"secret": "pst_test_your_key"
}
''' |
'''Create a Connection TokenTo connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.Parameters location optional The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see the docs on scoping connection tokens.ReturnsReturns a Connection Token
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.ConnectionToken.create()
'''Response {
"object": "terminal.connection_token",
"secret": "pst_test_your_key"
}''' |
'''LocationA Location represents a grouping of readers.
''''''Endpoints POST /v1/terminal/locations GET /v1/terminal/locations/:id POST /v1/terminal/locations/:idDELETE /v1/terminal/locations/:id GET /v1/terminal/locations
''' |
'''The location objectAttributes id string Unique identifier for the object. address hash The full address of the location.Show child attributes display_name string The display name of the location. metadata hash 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.More attributesExpand all object string, value is "terminal.location" configuration_overrides string livemode boolean
''''''The location object {
"id": "tml_5oQeOYRZZRY3Q3Vpdz1vRfaQ",
"object": "terminal.location",
"address": {
"city": "Stevieland",
"country": "BE",
"line1": "1016 Mohamed Rest Suite 549\nEast Fermin, AK 54642-6984",
"line2": null,
"postal_code": "07458-8074",
"state": null
},
"display_name": "My First Store",
"livemode": false,
"metadata": {}
}
''' |
'''Create a LocationCreates a new Location object.
For further details, including which address fields are required in each country, see the Manage locations guide.Parameters address required The full address of the location.Show child parameters display_name required A name for the location. metadata optional dictionary 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.More parametersExpand all configuration_overrides optional ReturnsReturns a Location object if creation succeeds
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Location.create(
display_name="My First Store",
address={
"line1": "1234 Main Street",
"city": "San Francisco",
"country": "US",
"postal_code": "94111",
},
)
'''Response {
"id": "tml_5oQeOYRZZRY3Q3Vpdz1vRfaQ",
"object": "terminal.location",
"address": {
"line1": "1234 Main Street",
"city": "San Francisco",
"country": "US",
"postal_code": "94111"
},
"display_name": "My First Store",
"livemode": false,
"metadata": {}
}''' |
'''Retrieve a LocationRetrieves a Location object.ParametersNo parameters.ReturnsReturns a Location object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Location.retrieve(
"tml_5oQeOYRZZRY3Q3Vpdz1vRfaQ",
)
'''Response {
"id": "tml_5oQeOYRZZRY3Q3Vpdz1vRfaQ",
"object": "terminal.location",
"address": {
"city": "Stevieland",
"country": "BE",
"line1": "1016 Mohamed Rest Suite 549\nEast Fermin, AK 54642-6984",
"line2": null,
"postal_code": "07458-8074",
"state": null
},
"display_name": "My First Store",
"livemode": false,
"metadata": {}
}''' |
'''Update a LocationUpdates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.Parameters address optional dictionary The full address of the location.Show child parameters display_name optional A name for the location. metadata optional dictionary 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.More parametersExpand all configuration_overrides optional ReturnsReturns an updated Location object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Location.modify(
"tml_5oQeOYRZZRY3Q3Vpdz1vRfaQ",
display_name="My First Store",
)
'''Response {
"id": "tml_5oQeOYRZZRY3Q3Vpdz1vRfaQ",
"object": "terminal.location",
"address": {
"city": "Stevieland",
"country": "BE",
"line1": "1016 Mohamed Rest Suite 549\nEast Fermin, AK 54642-6984",
"line2": null,
"postal_code": "07458-8074",
"state": null
},
"display_name": "My First Store",
"livemode": false,
"metadata": {}
}''' |
'''Delete a LocationDeletes a Location object.ParametersNo parameters.ReturnsReturns the Location object that was deleted
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Location.delete(
"tml_5oQeOYRZZRY3Q3Vpdz1vRfaQ",
)
'''Response {
"id": "tml_5oQeOYRZZRY3Q3Vpdz1vRfaQ",
"object": "terminal.location",
"deleted": true
}''' |
'''List all LocationsReturns a list of Location objects.ParametersExpand all ending_before optional limit optional starting_after optional ReturnsA dictionary with a data property that contains an array of up to limit locations, starting after location starting_after. Each entry in the array is a separate Terminal location object. If no more locations are available, the resulting array will be empty
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Location.list(limit=3)
'''Response {
"object": "list",
"url": "/v1/terminal/locations",
"has_more": false,
"data": [
{
"id": "tml_5oQeOYRZZRY3Q3Vpdz1vRfaQ",
"object": "terminal.location",
"address": {
"city": "Stevieland",
"country": "BE",
"line1": "1016 Mohamed Rest Suite 549\nEast Fermin, AK 54642-6984",
"line2": null,
"postal_code": "07458-8074",
"state": null
},
"display_name": "My First Store",
"livemode": false,
"metadata": {}
},
{...},
{...}
]
}''' |
'''ReaderA Reader represents a physical device for accepting payment details.
''''''Endpoints POST /v1/terminal/readers GET /v1/terminal/readers/:id POST /v1/terminal/readers/:idDELETE /v1/terminal/readers/:id GET /v1/terminal/readers POST /v1/terminal/readers/:id/process_payment_intent POST /v1/terminal/readers/:id/process_setup_intent POST /v1/terminal/readers/:id/set_reader_display POST /v1/terminal/readers/:id/cancel_action POST /v1/test_helpers/terminal/readers/:id/present_payment_method
''' |
'''The reader objectAttributes id string Unique identifier for the object. device_type string Type of reader, one of bbpos_wisepad3, stripe_m2, bbpos_chipper2x, bbpos_wisepos_e, verifone_P400, or simulated_wisepos_e. label string Custom label given to the reader for easier identification. location string expandable The location identifier of the reader. metadata hash 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. serial_number string Serial number of the reader. status string The networking status of the reader.More attributesExpand all object string, value is "terminal.reader" action hash preview feature device_sw_version string ip_address string livemode boolean
''''''The reader object {
"id": "tmr_btgOcOEM5hB0GOzeM19LioJf",
"object": "terminal.reader",
"action": null,
"device_sw_version": null,
"device_type": "bbpos_wisepos_e",
"ip_address": "192.168.2.2",
"label": "Blue Rabbit",
"livemode": false,
"location": null,
"metadata": {},
"serial_number": "123-456-789",
"status": "online"
}
''' |
'''Create a ReaderCreates a new Reader object.Parameters location required The location to assign the reader to. registration_code required A code generated by the reader used for registering to an account. label optional Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. metadata optional dictionary 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.ReturnsReturns a Reader object if creation succeeds
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Reader.create(
registration_code="puppies-plug-could",
label="Blue Rabbit",
location="tml_1234",
)
'''Response {
"id": "tmr_btgOcOEM5hB0GOzeM19LioJf",
"object": "terminal.reader",
"action": null,
"device_sw_version": null,
"device_type": "bbpos_wisepos_e",
"ip_address": "192.168.2.2",
"label": "Blue Rabbit",
"livemode": false,
"location": "tml_1234",
"metadata": {},
"serial_number": "123-456-789",
"status": "online",
"registration_code": "puppies-plug-could"
}''' |
'''Retrieve a ReaderRetrieves a Reader object.ParametersNo parameters.ReturnsReturns a Reader object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Reader.retrieve(
"tmr_btgOcOEM5hB0GOzeM19LioJf",
)
'''Response {
"id": "tmr_btgOcOEM5hB0GOzeM19LioJf",
"object": "terminal.reader",
"action": null,
"device_sw_version": null,
"device_type": "bbpos_wisepos_e",
"ip_address": "192.168.2.2",
"label": "Blue Rabbit",
"livemode": false,
"location": null,
"metadata": {},
"serial_number": "123-456-789",
"status": "online"
}''' |
'''Update a ReaderUpdates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.Parameters label optional The new label of the reader. metadata optional dictionary 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.ReturnsReturns an updated Reader object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Reader.modify(
"tmr_btgOcOEM5hB0GOzeM19LioJf",
label="Blue Rabbit",
)
'''Response {
"id": "tmr_btgOcOEM5hB0GOzeM19LioJf",
"object": "terminal.reader",
"action": null,
"device_sw_version": null,
"device_type": "bbpos_wisepos_e",
"ip_address": "192.168.2.2",
"label": "Blue Rabbit",
"livemode": false,
"location": null,
"metadata": {},
"serial_number": "123-456-789",
"status": "online"
}''' |
'''Delete a ReaderDeletes a Reader object.ParametersNo parameters.ReturnsReturns the Reader object that was deleted
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Reader.delete(
"tmr_btgOcOEM5hB0GOzeM19LioJf",
)
'''Response {
"id": "tmr_btgOcOEM5hB0GOzeM19LioJf",
"object": "terminal.reader",
"deleted": true
}''' |
'''List all ReadersReturns a list of Reader objects.Parameters device_type optional enum Filters readers by device typePossible enum valuesbbpos_wisepad3 stripe_m2 bbpos_chipper2x bbpos_wisepos_e verifone_P400 simulated_wisepos_e location optional A location ID to filter the response list to only readers at the specific location serial_number optional preview feature Filters readers by serial number status optional enum A status filter to filter readers to only offline or online readersPossible enum valuesoffline online More parametersExpand all ending_before optional limit optional starting_after optional ReturnsA dictionary with a data property that contains an array of up to limit readers, starting after reader starting_after. Each entry in the array is a separate Terminal Reader object. If no more readers are available, the resulting array will be empty
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Reader.list(limit=3)
'''Response {
"object": "list",
"url": "/v1/terminal/readers",
"has_more": false,
"data": [
{
"id": "tmr_btgOcOEM5hB0GOzeM19LioJf",
"object": "terminal.reader",
"action": null,
"device_sw_version": null,
"device_type": "bbpos_wisepos_e",
"ip_address": "192.168.2.2",
"label": "Blue Rabbit",
"livemode": false,
"location": null,
"metadata": {},
"serial_number": "123-456-789",
"status": "online"
},
{...},
{...}
]
}''' |
'''Hand-off a PaymentIntent to a ReaderInitiates a payment flow on a Reader.Parameters payment_intent required PaymentIntent IDMore parametersExpand all process_config optional dictionary ReturnsReturns an updated Reader resource
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Reader.process_payment_intent(
"tmr_btgOcOEM5hB0GOzeM19LioJf",
payment_intent="pi_1DrPsv2eZvKYlo2CEDzqXfPH",
)
'''Response {
"id": "tmr_btgOcOEM5hB0GOzeM19LioJf",
"object": "terminal.reader",
"action": {
"failure_code": null,
"failure_message": null,
"process_payment_intent": {
"payment_intent": "pi_1DrPsv2eZvKYlo2CEDzqXfPH"
},
"status": "in_progress",
"type": "process_payment_intent"
},
"device_sw_version": null,
"device_type": "bbpos_wisepos_e",
"ip_address": "192.168.2.2",
"label": "Blue Rabbit",
"livemode": false,
"location": null,
"metadata": {},
"serial_number": "123-456-789",
"status": "online"
}''' |
'''Hand-off a SetupIntent to a ReaderInitiates a setup intent flow on a Reader.Parameters customer_consent_collected required Customer Consent Collected setup_intent required SetupIntent IDReturnsReturns an updated Reader resource
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Reader.process_setup_intent(
"tmr_btgOcOEM5hB0GOzeM19LioJf",
setup_intent="seti_1EuLW12eZvKYlo2CSSF0PlLO",
customer_consent_collected="true",
)
'''Response {
"id": "tmr_btgOcOEM5hB0GOzeM19LioJf",
"object": "terminal.reader",
"action": {
"failure_code": null,
"failure_message": null,
"process_setup_intent": {
"setup_intent": "seti_1EuLW12eZvKYlo2CSSF0PlLO"
},
"status": "in_progress",
"type": "process_setup_intent"
},
"device_sw_version": null,
"device_type": "bbpos_wisepos_e",
"ip_address": "192.168.2.2",
"label": "Blue Rabbit",
"livemode": false,
"location": null,
"metadata": {},
"serial_number": "123-456-789",
"status": "online"
}''' |
'''Set reader displaySets reader display to show cart details.Parameters type required TypePossible enum valuescart cart optional dictionary CartShow child parametersReturnsReturns an updated Reader resource
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Reader.set_reader_display(
"tmr_btgOcOEM5hB0GOzeM19LioJf",
type="cart",
cart={
"currency": "usd",
"line_items": [
{
"amount": 5100,
"description": "Red t-shirt",
"quantity": 1,
},
],
"tax": 100,
"total": 5200,
},
)
'''Response {
"id": "tmr_btgOcOEM5hB0GOzeM19LioJf",
"object": "terminal.reader",
"action": {
"failure_code": null,
"failure_message": null,
"set_reader_display": {
"type": "cart",
"cart": {
"currency": "usd",
"line_items": [
{
"amount": 5100,
"description": "Red t-shirt",
"quantity": 1
}
],
"tax": 100,
"total": 5200
}
},
"status": "succeeded",
"type": "set_reader_display"
},
"device_sw_version": null,
"device_type": "bbpos_wisepos_e",
"ip_address": "192.168.2.2",
"label": "Blue Rabbit",
"livemode": false,
"location": null,
"metadata": {},
"serial_number": "123-456-789",
"status": "online"
}''' |
'''Cancel the current reader actionCancels the current reader action.ParametersNo parameters.ReturnsReturns an updated Reader resource
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Reader.cancel_action(
"tmr_btgOcOEM5hB0GOzeM19LioJf",
)
'''Response {
"id": "tmr_btgOcOEM5hB0GOzeM19LioJf",
"object": "terminal.reader",
"action": null,
"device_sw_version": null,
"device_type": "bbpos_wisepos_e",
"ip_address": "192.168.2.2",
"label": "Blue Rabbit",
"livemode": false,
"location": null,
"metadata": {},
"serial_number": "123-456-789",
"status": "online"
}''' |
'''Simulate presenting a payment methodPresents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.Parameters card_present optional dictionary Simulated data for the card_present payment methodShow child parameters type optional enum Simulated payment typePossible enum valuescard_present ReturnsReturns an updated Reader resource
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.terminal.Reader.TestHelpers.present_payment_method(
"tmr_btgOcOEM5hB0GOzeM19LioJf",
)
'''Response {
"id": "tmr_btgOcOEM5hB0GOzeM19LioJf",
"object": "terminal.reader",
"action": {
"failure_code": null,
"failure_message": null,
"process_payment_intent": {
"payment_intent": "pi_1DrPsv2eZvKYlo2CEDzqXfPH"
},
"status": "succeeded",
"type": "process_payment_intent"
},
"device_sw_version": null,
"device_type": "bbpos_wisepos_e",
"ip_address": "192.168.2.2",
"label": "Blue Rabbit",
"livemode": false,
"location": null,
"metadata": {},
"serial_number": "123-456-789",
"status": "online"
}''' |
'''ConfigurationA Configurations object represents how features should be configured for terminal readers
''''''Endpoints POST /v1/terminal/configurations GET /v1/terminal/configurations/:id POST /v1/terminal/configurations/:idDELETE /v1/terminal/configurations/:id GET /v1/terminal/configurations
''' |
'''The Configuration objectAttributes id string Unique identifier for the object. bbpos_wisepos_e hash An object containing device type specific settings for BBPOS WisePOS EShow child attributes is_account_default boolean Whether this Configuration is the default for your account tipping hash On-reader tipping settingsShow child attributes verifone_p400 hash An object containing device type specific settings for Verifone P400Show child attributesMore attributesExpand all object string, value is "terminal.configuration" livemode boolean
''''''The Configuration object {
"id": "tmc_ElVUAjF8xXG3hj",
"object": "terminal.configuration",
"bbpos_wisepos_e": {
"splashscreen": "file_1LSe6q2eZvKYlo2CU2r7wt6K"
},
"is_account_default": false,
"livemode": false
}
''' |
'''Create a ConfigurationCreates a new Configuration object.Parameters bbpos_wisepos_e optional dictionary An object containing device type specific settings for BBPOS WisePOS E readersShow child parameters tipping optional dictionary Tipping configurations for readers supporting on-reader tipsShow child parameters verifone_p400 optional dictionary An object containing device type specific settings for Verifone P400 readersShow child parametersReturnsReturns a Configuration object if creation succeeds
'''import stripe
stripe.api_key = "sk_test_4eC39HqLyjWDarjtT1zdp7dc"
stripe.terminal.Configuration.create(
bbpos_wisepos_e={
"splashscreen":
"file_1LSe6q2eZvKYlo2C44t5c528",
},
)
'''Response {
"id": "tmc_ElVUAjF8xXG3hj",
"object": "terminal.configuration",
"bbpos_wisepos_e": {
"splashscreen": "file_1LSe6q2eZvKYlo2C44t5c528"
},
"is_account_default": false,
"livemode": false
}''' |
'''Retrieve a ConfigurationRetrieves a Configuration object.ParametersNo parameters.ReturnsReturns a Configuration object if a valid identifier was provided
'''import stripe
stripe.api_key = "sk_test_4eC39HqLyjWDarjtT1zdp7dc"
stripe.terminal.Configuration.retrieve(
"tmc_ElVUAjF8xXG3hj",
)
'''Response {
"id": "tmc_ElVUAjF8xXG3hj",
"object": "terminal.configuration",
"bbpos_wisepos_e": {
"splashscreen": "file_1LSe6q2eZvKYlo2CU2r7wt6K"
},
"is_account_default": false,
"livemode": false
}''' |
'''Update a ConfigurationUpdates a new Configuration object.Parameters bbpos_wisepos_e optional dictionary An object containing device type specific settings for BBPOS WisePOS E readersShow child parameters tipping optional dictionary Tipping configurations for readers supporting on-reader tipsShow child parameters verifone_p400 optional dictionary An object containing device type specific settings for Verifone P400 readersShow child parametersReturnsReturns a Configuration object if the update succeeds
'''import stripe
stripe.api_key = "sk_test_4eC39HqLyjWDarjtT1zdp7dc"
stripe.terminal.Configuration.modify(
"tmc_ElVUAjF8xXG3hj",
bbpos_wisepos_e={
"splashscreen":
"file_1LSe6q2eZvKYlo2C44t5c528",
},
)
'''Response {
"id": "tmc_ElVUAjF8xXG3hj",
"object": "terminal.configuration",
"bbpos_wisepos_e": {
"splashscreen": "file_1LSe6q2eZvKYlo2C44t5c528"
},
"is_account_default": false,
"livemode": false
}''' |
'''Delete a ConfigurationDeletes a Configuration object.ParametersNo parameters.ReturnsReturns the Configuration object that was deleted
'''import stripe
stripe.api_key = "sk_test_4eC39HqLyjWDarjtT1zdp7dc"
stripe.terminal.Configuration.delete(
"tmc_ElVUAjF8xXG3hj",
)
'''Response {
"id": "tmc_ElVUAjF8xXG3hj",
"object": "terminal.configuration",
"deleted": true
}''' |
'''List all ConfigurationsReturns a list of Configuration objects.Parameters is_account_default optional if present, only return the account default or non-default configurations.More parametersExpand all ending_before optional limit optional starting_after optional ReturnsA dictionary with a data property that contains an array of up to limit configurations, starting after configurations configurations. Each entry in the array is a separate Terminal configurations object. If no more configurations are available, the resulting array will be empty
'''import stripe
stripe.api_key = "sk_test_4eC39HqLyjWDarjtT1zdp7dc"
stripe.terminal.Configuration.list(limit=3)
'''Response {
"object": "list",
"url": "/v1/terminal/configurations",
"has_more": false,
"data": [
{
"id": "tmc_ElVUAjF8xXG3hj",
"object": "terminal.configuration",
"bbpos_wisepos_e": {
"splashscreen": "file_1LSe6q2eZvKYlo2CU2r7wt6K"
},
"is_account_default": false,
"livemode": false
},
{...},
{...}
]
}''' |
'''FinancialAccountsStripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance.
FinancialAccounts serve as the source and destination of Treasury’s money movement APIs
''''''Endpoints POST /v1/treasury/financial_accounts POST /v1/treasury/financial_accounts/:id GET /v1/treasury/financial_accounts/:id GET /v1/treasury/financial_accounts
''' |
'''The FinancialAccount objectAttributes id string Unique identifier for the object. object string, value is "treasury.financial_account" String representing the object’s type. Objects of the same type share the same value. active_features array of enum values The array of paths to active Features in the Features hash.Possible enum valuescard_issuing outbound_payments.ach outbound_payments.us_domestic_wire financial_addresses.aba deposit_insurance intra_stripe_flows inbound_transfers.ach outbound_transfers.ach outbound_transfers.us_domestic_wire remote_deposit_capture balance hash The single multi-currency balance of the FinancialAccount. Positive values represent money that belongs to the user while negative values represent funds the user owes. Currently, FinancialAccounts can only carry balances in USD.Show child attributes country string Two-letter country code (ISO 3166-1 alpha-2). created timestamp Time at which the object was created. Measured in seconds since the Unix epoch. features hash expandable The features and their statuses for this FinancialAccount. This field is not included by default. To include it in the response, expand the features field.Show child attributes financial_addresses array of hashes The set of credentials that resolve to a FinancialAccount.Show child attributes livemode boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode. metadata hash 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. pending_features array of enum values The array of paths to pending Features in the Features hash.Possible enum valuescard_issuing outbound_payments.ach outbound_payments.us_domestic_wire financial_addresses.aba deposit_insurance intra_stripe_flows inbound_transfers.ach outbound_transfers.ach outbound_transfers.us_domestic_wire remote_deposit_capture platform_restrictions hash The set of functionalities that the platform can restrict on the FinancialAccount.Show child attributes restricted_features array of enum values The array of paths to restricted Features in the Features hash.Possible enum valuescard_issuing outbound_payments.ach outbound_payments.us_domestic_wire financial_addresses.aba deposit_insurance intra_stripe_flows inbound_transfers.ach outbound_transfers.ach outbound_transfers.us_domestic_wire remote_deposit_capture status enum The enum specifying what state the account is in.Possible enum valuesopen closed status_details hash Details related to the status of this FinancialAccount.Show child attributes supported_currencies array The currencies the FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase
''''''The FinancialAccount object {
"id": "fa_1LSdbB2eZvKYlo2Cq76guDva",
"object": "treasury.financial_account",
"active_features": [
"financial_addresses.aba",
"outbound_payments.ach",
"outbound_payments.us_domestic_wire"
],
"balance": {
"cash": {
"usd": 0
},
"inbound_pending": {
"usd": 0
},
"outbound_pending": {
"usd": 0
}
},
"country": "US",
"created": 1659517841,
"financial_addresses": [
{
"aba": {
"account_holder_name": "Jenny Rosen",
"account_number_last4": "7890",
"bank_name": "STRIPE TEST BANK",
"routing_number": "0000000001"
},
"supported_networks": [
"ach",
"us_domestic_wire"
],
"type": "aba"
}
],
"livemode": true,
"metadata": null,
"pending_features": [],
"restricted_features": [],
"status": "open",
"status_details": {
"closed": null
},
"supported_currencies": [
"usd"
]
}
''' |
'''Create a FinancialAccountCreates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.Parameters supported_currencies required The currencies the FinancialAccount can hold a balance in. features optional dictionary Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.Show child parameters metadata optional dictionary 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. platform_restrictions optional dictionary The set of functionalities that the platform can restrict on the FinancialAccount.Show child parametersReturnsReturns a FinancialAccount object
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.treasury.FinancialAccount.create(
supported_currencies=["usd"],
features={},
)
'''Response {
"id": "fa_1LSdbB2eZvKYlo2Cq76guDva",
"object": "treasury.financial_account",
"active_features": [
"financial_addresses.aba",
"outbound_payments.ach",
"outbound_payments.us_domestic_wire"
],
"balance": {
"cash": {
"usd": 0
},
"inbound_pending": {
"usd": 0
},
"outbound_pending": {
"usd": 0
}
},
"country": "US",
"created": 1659517841,
"financial_addresses": [
{
"aba": {
"account_holder_name": "Jenny Rosen",
"account_number_last4": "7890",
"bank_name": "STRIPE TEST BANK",
"routing_number": "0000000001"
},
"supported_networks": [
"ach",
"us_domestic_wire"
],
"type": "aba"
}
],
"livemode": true,
"metadata": null,
"pending_features": [],
"restricted_features": [],
"status": "open",
"status_details": {
"closed": null
},
"supported_currencies": [
"usd"
],
"features": {}
}''' |
'''Update a FinancialAccountUpdates the details of a FinancialAccount.Parameters features optional dictionary Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated status_details. Stripe or the platform may control features via the requested field.Show child parameters metadata optional dictionary 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. platform_restrictions optional dictionary The set of functionalities that the platform can restrict on the FinancialAccount.Show child parametersReturnsReturns a FinancialAccount object
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.treasury.FinancialAccount.modify(
"fa_1LSdbB2eZvKYlo2Cq76guDva",
metadata={"order_id": "6735"},
)
'''Response {
"id": "fa_1LSdbB2eZvKYlo2Cq76guDva",
"object": "treasury.financial_account",
"active_features": [
"financial_addresses.aba",
"outbound_payments.ach",
"outbound_payments.us_domestic_wire"
],
"balance": {
"cash": {
"usd": 0
},
"inbound_pending": {
"usd": 0
},
"outbound_pending": {
"usd": 0
}
},
"country": "US",
"created": 1659517841,
"financial_addresses": [
{
"aba": {
"account_holder_name": "Jenny Rosen",
"account_number_last4": "7890",
"bank_name": "STRIPE TEST BANK",
"routing_number": "0000000001"
},
"supported_networks": [
"ach",
"us_domestic_wire"
],
"type": "aba"
}
],
"livemode": true,
"metadata": {
"order_id": "6735"
},
"pending_features": [],
"restricted_features": [],
"status": "open",
"status_details": {
"closed": null
},
"supported_currencies": [
"usd"
]
}''' |
'''Retrieve a FinancialAccountRetrieves the details of a FinancialAccount.ParametersNo parameters.ReturnsReturn a FinancialAccount object
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.treasury.FinancialAccount.retrieve(
"fa_1LSdbB2eZvKYlo2Cq76guDva",
)
'''Response {
"id": "fa_1LSdbB2eZvKYlo2Cq76guDva",
"object": "treasury.financial_account",
"active_features": [
"financial_addresses.aba",
"outbound_payments.ach",
"outbound_payments.us_domestic_wire"
],
"balance": {
"cash": {
"usd": 0
},
"inbound_pending": {
"usd": 0
},
"outbound_pending": {
"usd": 0
}
},
"country": "US",
"created": 1659517841,
"financial_addresses": [
{
"aba": {
"account_holder_name": "Jenny Rosen",
"account_number_last4": "7890",
"bank_name": "STRIPE TEST BANK",
"routing_number": "0000000001"
},
"supported_networks": [
"ach",
"us_domestic_wire"
],
"type": "aba"
}
],
"livemode": true,
"metadata": null,
"pending_features": [],
"restricted_features": [],
"status": "open",
"status_details": {
"closed": null
},
"supported_currencies": [
"usd"
]
}''' |
'''List all FinancialAccountsReturns a list of FinancialAccounts.Parameters created optional dictionary A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:Show child parametersMore parametersExpand all ending_before optional limit optional starting_after optional ReturnsA dictionary with a data property that contains an array of up to limit FinancialAccounts, starting after FinancialAccount starting_after. Each entry in the array is a separate FinancialAccount object. If no more FinancialAccounts are available, the resulting array is empty
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.treasury.FinancialAccount.list(limit=3)
'''Response {
"object": "list",
"url": "/v1/treasury/financial_accounts",
"has_more": false,
"data": [
{
"id": "fa_1LSdbB2eZvKYlo2Cq76guDva",
"object": "treasury.financial_account",
"active_features": [
"financial_addresses.aba",
"outbound_payments.ach",
"outbound_payments.us_domestic_wire"
],
"balance": {
"cash": {
"usd": 0
},
"inbound_pending": {
"usd": 0
},
"outbound_pending": {
"usd": 0
}
},
"country": "US",
"created": 1659517841,
"financial_addresses": [
{
"aba": {
"account_holder_name": "Jenny Rosen",
"account_number_last4": "7890",
"bank_name": "STRIPE TEST BANK",
"routing_number": "0000000001"
},
"supported_networks": [
"ach",
"us_domestic_wire"
],
"type": "aba"
}
],
"livemode": true,
"metadata": null,
"pending_features": [],
"restricted_features": [],
"status": "open",
"status_details": {
"closed": null
},
"supported_currencies": [
"usd"
]
},
{...},
{...}
]
}''' |
'''FinancialAccount FeaturesEncodes whether a FinancialAccount has access to a particular Feature, with a status enum and associated status_details.
Stripe or the platform can control Features via the requested field
''''''Endpoints POST /v1/treasury/financial_accounts/:id/features GET /v1/treasury/financial_accounts/:id/features
''' |
'''The FinancialAccount Feature objectAttributes object string, value is "treasury.financial_account_features" String representing the object’s type. Objects of the same type share the same value. card_issuing hash Contains a Feature encoding the FinancialAccount’s ability to be used with the Issuing product, including attaching cards to and drawing funds from.Show child attributes deposit_insurance hash Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.Show child attributes financial_addresses hash Contains Features that add FinancialAddresses to the FinancialAccount.Show child attributes inbound_transfers hash Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.Show child attributes intra_stripe_flows hash Represents the ability for this FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).Show child attributes outbound_payments hash Contains Features related to initiating money movement out of the FinancialAccount to someone else’s bucket of money.Show child attributes outbound_transfers hash Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.Show child attribute
''''''The FinancialAccount Feature object {
"object": "treasury.financial_account_features",
"card_issuing": {
"requested": true,
"status": "active",
"status_details": []
},
"deposit_insurance": {
"requested": true,
"status": "active",
"status_details": []
},
"financial_addresses": {
"aba": {
"requested": true,
"status": "active",
"status_details": []
}
},
"inbound_transfers": {
"ach": {
"requested": true,
"status": "active",
"status_details": []
}
},
"intra_stripe_flows": {
"requested": true,
"status": "active",
"status_details": []
},
"outbound_payments": {
"ach": {
"requested": true,
"status": "active",
"status_details": []
},
"us_domestic_wire": {
"requested": true,
"status": "active",
"status_details": []
}
},
"outbound_transfers": {
"ach": {
"requested": true,
"status": "active",
"status_details": []
},
"us_domestic_wire": {
"requested": true,
"status": "active",
"status_details": []
}
}
}
''' |
'''Update FinancialAccount FeaturesUpdates the Features associated with a FinancialAccount.Parameters card_issuing optional dictionary Encodes the FinancialAccount’s ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.Show child parameters deposit_insurance optional dictionary Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.Show child parameters financial_addresses optional dictionary Contains Features that add FinancialAddresses to the FinancialAccount.Show child parameters inbound_transfers optional dictionary Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.Show child parameters intra_stripe_flows optional dictionary Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).Show child parameters outbound_payments optional dictionary Includes Features related to initiating money movement out of the FinancialAccount to someone else’s bucket of money.Show child parameters outbound_transfers optional dictionary Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.Show child parametersReturnsA dictionary of Features associated with the given FinancialAccount. Each entry in the dictionary is a Feature object, which may contain child Features
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.treasury.FinancialAccount.modify_financial_account_features(
"fa_1LSdrV2eZvKYlo2C1rw3AuSN",
card_issuing={"requested": False},
)
'''Response {
"object": "treasury.financial_account_features",
"deposit_insurance": {
"requested": true,
"status": "active",
"status_details": []
},
"financial_addresses": {
"aba": {
"requested": true,
"status": "active",
"status_details": []
}
},
"inbound_transfers": {
"ach": {
"requested": true,
"status": "active",
"status_details": []
}
},
"intra_stripe_flows": {
"requested": true,
"status": "active",
"status_details": []
},
"outbound_payments": {
"ach": {
"requested": true,
"status": "active",
"status_details": []
},
"us_domestic_wire": {
"requested": true,
"status": "active",
"status_details": []
}
},
"outbound_transfers": {
"ach": {
"requested": true,
"status": "active",
"status_details": []
},
"us_domestic_wire": {
"requested": true,
"status": "active",
"status_details": []
}
}
}''' |
'''Retrieve FinancialAccount FeaturesRetrieves Features information associated with the FinancialAccount.ParametersNo parameters.ReturnsA dictionary of Features associated with the given FinancialAccount. Each entry in the dictionary is a Feature object, which might contain child Features
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.treasury.FinancialAccount.retrieve_feature(
"fa_1LSdrV2eZvKYlo2C1rw3AuSN",
)
'''Response {
"object": "treasury.financial_account_features",
"card_issuing": {
"requested": true,
"status": "active",
"status_details": []
},
"deposit_insurance": {
"requested": true,
"status": "active",
"status_details": []
},
"financial_addresses": {
"aba": {
"requested": true,
"status": "active",
"status_details": []
}
},
"inbound_transfers": {
"ach": {
"requested": true,
"status": "active",
"status_details": []
}
},
"intra_stripe_flows": {
"requested": true,
"status": "active",
"status_details": []
},
"outbound_payments": {
"ach": {
"requested": true,
"status": "active",
"status_details": []
},
"us_domestic_wire": {
"requested": true,
"status": "active",
"status_details": []
}
},
"outbound_transfers": {
"ach": {
"requested": true,
"status": "active",
"status_details": []
},
"us_domestic_wire": {
"requested": true,
"status": "active",
"status_details": []
}
},
"id": "fa_1LSdrV2eZvKYlo2C1rw3AuSN"
}''' |
'''TransactionsTransactions represent changes to a FinancialAccount's balance
''''''Endpoints GET /v1/treasury/transactions/:id GET /v1/treasury/transactions
''' |
'''The Transaction objectAttributes id string Unique identifier for the object. object string, value is "treasury.transaction" String representing the object’s type. Objects of the same type share the same value. amount integer Amount (in cents) transferred. balance_impact hash The change made to each of the FinancialAccount’s sub-balances by the Transaction.Show child attributes created timestamp Time at which the object was created. Measured in seconds since the Unix epoch. currency currency Three-letter ISO currency code, in lowercase. Must be a supported currency. description string An arbitrary string attached to the object. Often useful for displaying to users. entries list expandable A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints. This field is not included by default. To include it in the response, expand the entries field.Show child attributes financial_account string The FinancialAccount associated with this object. flow string ID of the flow that created the Transaction. flow_details hash expandable Details of the flow that created the Transaction. This field is not included by default. To include it in the response, expand the flow_details field.Show child attributes flow_type enum Type of the flow that created the Transaction.Possible enum valuesinbound_transfer The Transaction is associated with an InboundTransfer.issuing_authorization The Transaction is associated with an Issuing authorization.outbound_payment The Transaction is associated with an OutboundPayment.outbound_transfer The Transaction is associated with an OutboundTransfer.received_credit The Transaction is associated with a ReceivedCredit.received_debit The Transaction is associated with a ReceivedDebit.credit_reversal The Transaction is associated with a CreditReversal.debit_reversal The Transaction is associated with a DebitReversal.other The Transaction is associated with some other money movement not listed above. livemode boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode. status enum Status of the Transaction.Possible enum valuesopen The initial state for all Transactions. The Transaction results in updates to the sub-balance amounts, but the current balance is not affected until the Transaction posts.posted Funds have successfully entered or left the account. The current balance was affected.void The Transaction never impacted the balance. For example, a Transaction would enter this state if an OutboundPayment was initiated but then canceled before the funds left the account. status_transitions hash Hash containing timestamps of when the object transitioned to a particular status.Show child attribute
''''''The Transaction object {
"id": "trxn_1LSdcS2eZvKYlo2CvaRGIFEN",
"object": "treasury.transaction",
"amount": -100,
"balance_impact": {
"cash": -100,
"inbound_pending": 0,
"outbound_pending": 100
},
"created": 1659517920,
"currency": "usd",
"description": "Jane Austen (6789) | Outbound transfer | transfer",
"financial_account": "fa_1LSdcS2eZvKYlo2C9OkJJG35",
"flow": "obt_1LSdcS2eZvKYlo2C57nEGLrc",
"flow_type": "outbound_transfer",
"livemode": false,
"status": "open",
"status_transitions": {
"posted_at": null,
"void_at": null
}
}
''' |
'''Retrieve a TransactionRetrieves the details of an existing Transaction.ParametersNo parameters.ReturnsReturns a Transaction object if a valid identifier was provided. Otherwise, returns an error
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.treasury.Transaction.retrieve(
"trxn_1LSdcS2eZvKYlo2CvaRGIFEN",
)
'''Response {
"id": "trxn_1LSdcS2eZvKYlo2CvaRGIFEN",
"object": "treasury.transaction",
"amount": -100,
"balance_impact": {
"cash": -100,
"inbound_pending": 0,
"outbound_pending": 100
},
"created": 1659517920,
"currency": "usd",
"description": "Jane Austen (6789) | Outbound transfer | transfer",
"financial_account": "fa_1LSdcS2eZvKYlo2C9OkJJG35",
"flow": "obt_1LSdcS2eZvKYlo2C57nEGLrc",
"flow_type": "outbound_transfer",
"livemode": false,
"status": "open",
"status_transitions": {
"posted_at": null,
"void_at": null
}
}''' |
'''List all TransactionsRetrieves a list of Transaction objects.Parameters financial_account required Returns objects associated with this FinancialAccount. created optional dictionary A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:Show child parameters order_by optional enum The results are in reverse chronological order by created or posted_at. The default is created.Possible enum valuescreated Timestamp describing when the Transaction was created.posted_at Timestamp describing when the Transaction was posted. status optional enum Only return Transactions that have the given status: open, posted, or void.Possible enum valuesopen The initial state for all Transactions. The Transaction results in updates to the sub-balance amounts, but the current balance is not affected until the Transaction posts.posted Funds have successfully entered or left the account. The current balance was affected.void The Transaction never impacted the balance. For example, a Transaction would enter this state if an OutboundPayment was initiated but then canceled before the funds left the account. status_transitions optional dictionary A filter for the status_transitions.posted_at timestamp. When using this filter, status=posted and order_by=posted_at must also be specified.Show child parametersMore parametersExpand all ending_before optional limit optional starting_after optional ReturnsA 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 Transaction object. If no more Transactions are available, the resulting array will be empty
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.treasury.Transaction.list(
financial_account="fa_1LSdcS2eZvKYlo2C9OkJJG35",
limit=3,
)
'''Response {
"object": "list",
"url": "/v1/treasury/transactions",
"has_more": false,
"data": [
{
"id": "trxn_1LSdcS2eZvKYlo2CvaRGIFEN",
"object": "treasury.transaction",
"amount": -100,
"balance_impact": {
"cash": -100,
"inbound_pending": 0,
"outbound_pending": 100
},
"created": 1659517920,
"currency": "usd",
"description": "Jane Austen (6789) | Outbound transfer | transfer",
"financial_account": "fa_1LSdcS2eZvKYlo2C9OkJJG35",
"flow": "obt_1LSdcS2eZvKYlo2C57nEGLrc",
"flow_type": "outbound_transfer",
"livemode": false,
"status": "open",
"status_transitions": {
"posted_at": null,
"void_at": null
}
},
{...},
{...}
]
}''' |
'''TransactionEntriesTransactionEntries represent individual units of money movements within a single Transaction
''''''Endpoints GET /v1/treasury/transaction_entries/:id GET /v1/treasury/transaction_entries
''' |
'''The TransactionEntry objectAttributes id string Unique identifier for the object. object string, value is "treasury.transaction_entry" String representing the object’s type. Objects of the same type share the same value. balance_impact hash The current impact of the TransactionEntry on the FinancialAccount’s balance.Show child attributes created timestamp Time at which the object was created. Measured in seconds since the Unix epoch. currency currency Three-letter ISO currency code, in lowercase. Must be a supported currency. effective_at timestamp When the TransactionEntry will impact the FinancialAccount’s balance. financial_account string The FinancialAccount associated with this object. flow string Token of the flow associated with the TransactionEntry. flow_details hash expandable Details of the flow associated with the TransactionEntry. This field is not included by default. To include it in the response, expand the flow_details field.Show child attributes flow_type enum Type of the flow associated with the TransactionEntry.Possible enum valuesinbound_transfer The Transaction is associated with an InboundTransfer.issuing_authorization The Transaction is associated with an Issuing authorization.outbound_payment The Transaction is associated with an OutboundPayment.outbound_transfer The Transaction is associated with an OutboundTransfer.received_credit The Transaction is associated with a ReceivedCredit.received_debit The Transaction is associated with a ReceivedDebit.credit_reversal The Transaction is associated with a CreditReversal.debit_reversal The Transaction is associated with a DebitReversal.other The Transaction is associated with some other money movement not listed above. livemode boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode. transaction string expandable The Transaction associated with this object. type enum The specific money movement that generated the TransactionEntry.Possible enum valuesoutbound_payment The TransactionEntry was generated by an OutboundPayment.outbound_payment_cancellation The TransactionEntry was generated by a cancelled OutboundPayment.outbound_payment_failure The TransactionEntry was generated by a failed OutboundPayment.outbound_payment_posting The TransactionEntry was generated by a posted OutboundPayment.outbound_payment_return The TransactionEntry was generated by a returned OutboundPayment.outbound_transfer The TransactionEntry was generated by an OutboundTransfer.outbound_transfer_cancellation The TransactionEntry was generated by a canceled OutboundTransfer.Show 13 mor
''''''The TransactionEntry object {
"id": "trxne_1LSdcT2eZvKYlo2CSclqAhpM",
"object": "treasury.transaction_entry",
"balance_impact": {
"cash": 0,
"inbound_pending": 0,
"outbound_pending": -1000
},
"created": 1659517921,
"currency": "usd",
"effective_at": 1659517921,
"financial_account": "fa_1LSdcS2eZvKYlo2C9OkJJG35",
"flow": "obt_1LSdcS2eZvKYlo2C57nEGLrc",
"flow_type": "outbound_transfer",
"livemode": false,
"transaction": "trxn_1LSdcS2eZvKYlo2CvaRGIFEN",
"type": "outbound_transfer"
}
''' |
'''Retrieve a TransactionEntryRetrieves a TransactionEntry object.ParametersNo parameters.ReturnsReturns a TransactionEntry object
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.treasury.TransactionEntry.retrieve(
"trxne_1LSdcT2eZvKYlo2CSclqAhpM",
)
'''Response {
"id": "trxne_1LSdcT2eZvKYlo2CSclqAhpM",
"object": "treasury.transaction_entry",
"balance_impact": {
"cash": 0,
"inbound_pending": 0,
"outbound_pending": -1000
},
"created": 1659517921,
"currency": "usd",
"effective_at": 1659517921,
"financial_account": "fa_1LSdcS2eZvKYlo2C9OkJJG35",
"flow": "obt_1LSdcS2eZvKYlo2C57nEGLrc",
"flow_type": "outbound_transfer",
"livemode": false,
"transaction": "trxn_1LSdcS2eZvKYlo2CvaRGIFEN",
"type": "outbound_transfer"
}''' |
'''List all TransactionEntriesRetrieves a list of TransactionEntry objects.Parameters financial_account required Returns objects associated with this FinancialAccount. created optional dictionary A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:Show child parameters effective_at optional dictionary A filter on the list based on the object effective_at field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:Show child parameters order_by optional enum The results are in reverse chronological order by created or effective_at. The default is created.Possible enum valuescreated Timestamp describing when the TransactionEntry was created.effective_at Timestamp describing when the TransactionEntry was effective. transaction optional Only return TransactionEntries associated with this Transaction.More parametersExpand all ending_before optional limit optional starting_after optional ReturnsA dictionary with a data property that contains an array of up to limit TransactionEntries, starting after TransactionEntry starting_after. Each entry in the array is a separate TransactionEntry object. If no more TransactionEntries are available, the resulting array is empty
'''import stripe
stripe.api_key = "sk_test_your_key"
stripe.treasury.TransactionEntry.list(
financial_account="fa_1LSdcS2eZvKYlo2C9OkJJG35",
limit=3,
)
'''Response {
"object": "list",
"url": "/v1/treasury/transaction_entrys",
"has_more": false,
"data": [
{
"id": "trxne_1LSdcT2eZvKYlo2CSclqAhpM",
"object": "treasury.transaction_entry",
"balance_impact": {
"cash": 0,
"inbound_pending": 0,
"outbound_pending": -1000
},
"created": 1659517921,
"currency": "usd",
"effective_at": 1659517921,
"financial_account": "fa_1LSdcS2eZvKYlo2C9OkJJG35",
"flow": "obt_1LSdcS2eZvKYlo2C57nEGLrc",
"flow_type": "outbound_transfer",
"livemode": false,
"transaction": "trxn_1LSdcS2eZvKYlo2CvaRGIFEN",
"type": "outbound_transfer"
},
{...},
{...}
]
}''' |