getSourcesSourceSourceTransactions
List source transactions for a given source.
Details
- Method:
GET - Path:
/v1/sources/{source}/source_transactions - Operation ID:
GetSourcesSourceSourceTransactions
Parameters
{
"ending_before": {
"description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
"required": false,
"location": "query",
"type": "string"
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"required": false,
"location": "query",
"type": "array"
},
"limit": {
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
"required": false,
"location": "query",
"type": "integer"
},
"source": {
"description": "",
"required": true,
"location": "path",
"type": "string"
},
"starting_after": {
"description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"description": "",
"properties": {
"data": {
"items": {
"description": "Some payment methods have no required amount that a customer must send.\nCustomers can be instructed to send any amount, and it can be made up of\nmultiple transactions. As such, sources can have multiple associated\ntransactions.",
"properties": {
"ach_credit_transfer": {
"description": "",
"properties": {
"customer_data": {
"description": "Customer data associated with the transfer.",
"maxLength": 5000,
"type": "string"
},
"fingerprint": {
"description": "Bank account fingerprint associated with the transfer.",
"maxLength": 5000,
"type": "string"
},
"last4": {
"description": "Last 4 digits of the account number associated with the transfer.",
"maxLength": 5000,
"type": "string"
},
"routing_number": {
"description": "Routing number associated with the transfer.",
"maxLength": 5000,
"type": "string"
}
},
"title": "SourceTransactionAchCreditTransferData",
"type": "object",
"x-expandableFields": []
},
"amount": {
"description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount your customer has pushed to the receiver.",
"type": "integer"
},
"chf_credit_transfer": {
"description": "",
"properties": {
"reference": {
"description": "Reference associated with the transfer.",
"maxLength": 5000,
"type": "string"
},
"sender_address_country": {
"description": "Sender's country address.",
"maxLength": 5000,
"type": "string"
},
"sender_address_line1": {
"description": "Sender's line 1 address.",
"maxLength": 5000,
"type": "string"
},
"sender_iban": {
"description": "Sender's bank account IBAN.",
"maxLength": 5000,
"type": "string"
},
"sender_name": {
"description": "Sender's name.",
"maxLength": 5000,
"type": "string"
}
},
"title": "SourceTransactionChfCreditTransferData",
"type": "object",
"x-expandableFields": []
},
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
"format": "unix-time",
"type": "integer"
},
"currency": {
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
"format": "currency",
"type": "string"
},
"gbp_credit_transfer": {
"description": "",
"properties": {
"fingerprint": {
"description": "Bank account fingerprint associated with the Stripe owned bank account receiving the transfer.",
"maxLength": 5000,
"type": "string"
},
"funding_method": {
"description": "The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported.",
"maxLength": 5000,
"type": "string"
},
"last4": {
"description": "Last 4 digits of sender account number associated with the transfer.",
"maxLength": 5000,
"type": "string"
},
"reference": {
"description": "Sender entered arbitrary information about the transfer.",
"maxLength": 5000,
"type": "string"
},
"sender_account_number": {
"description": "Sender account number associated with the transfer.",
"maxLength": 5000,
"type": "string"
},
"sender_name": {
"description": "Sender name associated with the transfer.",
"maxLength": 5000,
"type": "string"
},
"sender_sort_code": {
"description": "Sender sort code associated with the transfer.",
"maxLength": 5000,
"type": "string"
}
},
"title": "SourceTransactionGbpCreditTransferData",
"type": "object",
"x-expandableFields": []
},
"id": {
"description": "Unique identifier for the object.",
"maxLength": 5000,
"type": "string"
},
"livemode": {
"description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
"type": "boolean"
},
"object": {
"description": "String representing the object's type. Objects of the same type share the same value.",
"enum": [
"source_transaction"
],
"type": "string"
},
"paper_check": {
"description": "",
"properties": {
"available_at": {
"description": "Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch.",
"maxLength": 5000,
"type": "string"
},
"invoices": {
"description": "Comma-separated list of invoice IDs associated with the paper check.",
"maxLength": 5000,
"type": "string"
}
},
"title": "SourceTransactionPaperCheckData",
"type": "object",
"x-expandableFields": []
},
"sepa_credit_transfer": {
"description": "",
"properties": {
"reference": {
"description": "Reference associated with the transfer.",
"maxLength": 5000,
"type": "string"
},
"sender_iban": {
"description": "Sender's bank account IBAN.",
"maxLength": 5000,
"type": "string"
},
"sender_name": {
"description": "Sender's name.",
"maxLength": 5000,
"type": "string"
}
},
"title": "SourceTransactionSepaCreditTransferData",
"type": "object",
"x-expandableFields": []
},
"source": {
"description": "The ID of the source this transaction is attached to.",
"maxLength": 5000,
"type": "string"
},
"status": {
"description": "The status of the transaction, one of `succeeded`, `pending`, or `failed`.",
"maxLength": 5000,
"type": "string"
},
"type": {
"description": "The type of source this transaction is attached to.",
"enum": [
"ach_credit_transfer",
"ach_debit",
"alipay",
"bancontact",
"card",
"card_present",
"eps",
"giropay",
"ideal",
"klarna",
"multibanco",
"p24",
"sepa_debit",
"sofort",
"three_d_secure",
"wechat"
],
"type": "string"
}
},
"required": [
"amount",
"created",
"currency",
"id",
"livemode",
"object",
"source",
"status",
"type"
],
"title": "SourceTransaction",
"type": "object",
"x-expandableFields": [
"ach_credit_transfer",
"chf_credit_transfer",
"gbp_credit_transfer",
"paper_check",
"sepa_credit_transfer"
],
"x-resourceId": "source_transaction"
},
"type": "array"
},
"has_more": {
"description": "True if this list has another page of items after this one that can be fetched.",
"type": "boolean"
},
"object": {
"description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
"enum": [
"list"
],
"type": "string"
},
"url": {
"description": "The URL where this list can be accessed.",
"maxLength": 5000,
"type": "string"
}
},
"required": [
"data",
"has_more",
"object",
"url"
],
"title": "ApmsSourcesSourceTransactionList",
"type": "object",
"x-expandableFields": [
"data"
]
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('stripe')
# Call this tool
result = await agent.call_tool('getSourcesSourceSourceTransactions', {
# Add required parameters here
})