POST /sandbox/transactions/create
Use the /sandbox/transactions/create
endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time.
This endpoint is only available in the Sandbox environment, thus can only be used with Items that were created in the Sandbox. You can use this to add transactions to test the /transactions/get
and /transactions/sync
endpoints.
For Items created in the Production environment, real transactions will be available once the transactions product is enabled.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
transactions[] |
Array | Yes |
List of transactions to be added |
transactions[].description |
String | Yes |
The transaction description. |
transactions[].date_posted |
String | Yes |
The date the transaction posted, in ISO 8601 (YYYY-MM-DD) format. Posted date must be the present date or a date up to 14 days in the past. Future dates are not allowed. |
transactions[].amount |
Number | Yes |
The transaction amount. Can be negative. |
transactions[].date_transacted |
String | Yes |
The date of the transaction, in ISO 8601 (YYYY-MM-DD) format. Transaction date must be the present date or a date up to 14 days in the past. Future dates are not allowed. |
transactions[].iso_currency_code |
String | No |
The ISO-4217 format currency code for the transaction. Defaults to USD. |
client_id |
String | No |
Your Plaid API |
access_token |
String | Yes |
The access token associated with the Item data is being requested for. |
secret |
String | No |
Your Plaid API |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.