{ "opencollection": "1.0.0", "info": { "name": "Bud API Services: Documentation Aggregation Buckets Ingest First Party Data API", "version": "2.10.10" }, "items": [ { "info": { "name": "Ingest First Party Data", "type": "folder" }, "items": [ { "info": { "name": "Ingest Accounts", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.thisisbud.com/v2/ingest/accounts", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" }, { "name": "Content-Type", "value": "" }, { "name": "X-Disable-Synchronous", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint is for pushing customer(s) account(s) and balance(s) through the Bud architecture.\nIt can ingest data for multiple customers per request.\nBy default, this is synchronous and will report any issue with the data in the response.\nIf a 'X-Disable-Synchronous' header is present and set to true, the process will create a task in the background and be entirely 'non-blocking'.\nIn this scenario, the response metadata will contain a Task ID and the next URL which would then be used for findi" }, { "info": { "name": "Close Accounts", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.thisisbud.com/ingestion/v3/accounts/close", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Close one or more accounts for a given customer. This will set the account status to closed and set the `closed_at` field on the __Retrieve Accounts V3__ response.\n\nIf an account is already closed, then the request will be ignored, and the `closed_at` field will remain unchanged.\n\nIf a 400 response is returned, any accountIDs or customerIDs __not__ defailted in the error response will have been closed succesfully.\n" }, { "info": { "name": "Reopen Accounts", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.thisisbud.com/ingestion/v3/accounts/reopen", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Reopen one or more accounts for a given customer. This will remove the account status and `closed_at` fields on the __Retrieve Accounts V3__ response.\n\nIf an account is already open, then the request will be ignored and the account is unchanged.\n\nIf a 400 response is returned, any accountIDs or customerIDs __not__ defailted in the error response will have been reopened succesfully.\n" }, { "info": { "name": "Ingest Transactions", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.thisisbud.com/v2/ingest/transactions", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" }, { "name": "Content-Type", "value": "" }, { "name": "X-Disable-Synchronous", "value": "" }, { "name": "X-Generate-Transaction-IDs", "value": "true" }, { "name": "X-Bud-Categorisation-Model", "value": "" }, { "name": "X-No-Customer", "value": "true" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint should be used to ingest customer transactions into the Bud Platform.\n\nBy default, this endpoint is synchronous but can be easily switched to asynchronous using the 'X-Disable-Synchronous' header.\nPlease refer to the following [guide](https://docs.thisisbud.com/docs/setup_data_enrichment) to ensure you set up First Party Ingestion\ncorrectly for your organisation based on your use case.\n\nWe accept a maximum of 1.000 transactions. If this threshold is not respected, a 400 error is re" }, { "info": { "name": "Book Transactions", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.thisisbud.com/ingestion/v3/transactions/book", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The Book Transactions endpoint, allows transactions ingested with a `status` of `pending` to set their status to `booked`.\n\nThe date_time field indicates the timestamp when the transaction booked. This is reflected in the `date_time` of __Retrieve Transactions V2__.\n" }, { "info": { "name": "Decline Transactions", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.thisisbud.com/ingestion/v3/transactions/decline", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The Decline Transactions endpoint, allows transactions ingested with a `status` of `pending` to set their status to `declined`.\n\nThe date_time field indicates the timestamp when the transaction declined. This is reflected in the `date_time` of __Retrieve Transactions V2__.\n" }, { "info": { "name": "Retrieve Ingestion Task Status", "type": "http" }, "http": { "method": "GET", "url": "https://api-sandbox.thisisbud.com/ingestion/v3/tasks/:task_id", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "Bud Task identifier returned from an async task for the requested action" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Check the status of an ingest request. Please note that this works for both the Ingest Transactions endpoints And Ingest Accounts endpoints.\nReports status of the ingestion task, with details for each subtask (1 per customer).\n" } ] } ], "bundled": true }