{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/payments:belvo/links-list-all":{"get":{"operationId":"payments_belvo_links_list_all","summary":"List all links","description":"GET /api/links","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"id","in":"query","required":false,"description":"Return information only for this resource `id`.","schema":{"type":"string","description":"Return information only for this resource `id`."}},{"name":"id__in","in":"query","required":false,"description":"Return information for these resource `id`s.","schema":{"type":"array","description":"Return information for these resource `id`s."}},{"name":"institution","in":"query","required":false,"description":"Return results only for this institution (use the Belvo-designated name, such as `erebor_mx_retail`).","schema":{"type":"string","description":"Return results only for this institution (use the Belvo-designated name, such as `erebor_mx_retail`)."}},{"name":"institution__in","in":"query","required":false,"description":"Return results only for these institutions (use the Belvo-designated names, such as `erebor_mx_retail` and `gringotts_mx_retail`).","schema":{"type":"array","description":"Return results only for these institutions (use the Belvo-designated names, such as `erebor_mx_retail` and `gringotts_mx_retail`)."}},{"name":"access_mode","in":"query","required":false,"description":"Return links only with this access mode. Can be either `single` or `recurrent`.","schema":{"type":"string","description":"Return links only with this access mode. Can be either `single` or `recurrent`."}},{"name":"created_at","in":"query","required":false,"description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__range","in":"query","required":false,"description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format).","schema":{"type":"array","description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format)."}},{"name":"created_by__not_in","in":"query","required":false,"description":"Return links that were not created by these Belvo users.","schema":{"type":"array","description":"Return links that were not created by these Belvo users."}},{"name":"external_id","in":"query","required":false,"description":"Return links with this external ID.","schema":{"type":"string","description":"Return links with this external ID."}},{"name":"external_id__in","in":"query","required":false,"description":"Return links with these external IDs.","schema":{"type":"array","description":"Return links with these external IDs."}},{"name":"institution_user_id","in":"query","required":false,"description":"Return links with this specific institution user ID.","schema":{"type":"string","description":"Return links with this specific institution user ID."}},{"name":"institution_user_id__in","in":"query","required":false,"description":"Return links with these institution user IDs.","schema":{"type":"array","description":"Return links with these institution user IDs."}},{"name":"refresh_rate","in":"query","required":false,"description":"Return links with this refresh rate. Choose between `6h`, `12h`, `24h`, `7d`, or `30d`.","schema":{"type":"string","description":"Return links with this refresh rate. Choose between `6h`, `12h`, `24h`, `7d`, or `30d`."}},{"name":"status","in":"query","required":false,"description":"Return links with this status. Choose between `valid`, `invalid`, `unconfirmed`, or `token_required`.","schema":{"type":"string","description":"Return links with this status. Choose between `valid`, `invalid`, `unconfirmed`, or `token_required`."}},{"name":"status__in","in":"query","required":false,"description":"Return links with these statuses. Choose between `valid`, `invalid`, `unconfirmed`, or `token_required`.","schema":{"type":"array","description":"Return links with these statuses. Choose between `valid`, `invalid`, `unconfirmed`, or `token_required`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/links-register-new-link":{"post":{"operationId":"payments_belvo_links_register_new_link","summary":"Register a new link","description":"POST /api/links","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/links-resume-session":{"post":{"operationId":"payments_belvo_links_resume_session","summary":"Complete a links request","description":"PATCH /api/links","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/links-get-details":{"get":{"operationId":"payments_belvo_links_get_details","summary":"Get a link's details","description":"GET /api/links/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `link.id` you want to get detailed information about.","schema":{"type":"string","description":"The `link.id` you want to get detailed information about."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/links-update-credentials":{"post":{"operationId":"payments_belvo_links_update_credentials","summary":"Update a link's credentials","description":"PUT /api/links/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The `link.id` you want to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/links-change-access-mode":{"post":{"operationId":"payments_belvo_links_change_access_mode","summary":"Change a link's access mode","description":"PATCH /api/links/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The `link.id` you want to change the `access_mode` for."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/links-delete-link-accounts":{"post":{"operationId":"payments_belvo_links_delete_link_accounts","summary":"Delete a link","description":"DELETE /api/links/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `link.id` that you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/accounts-list-all":{"get":{"operationId":"payments_belvo_accounts_list_all","summary":"List all accounts","description":"GET /api/accounts","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"balance__available","in":"query","required":false,"description":"Return accounts that have a `balance.available` matching exactly this value.","schema":{"type":"number","description":"Return accounts that have a `balance.available` matching exactly this value."}},{"name":"balance__available__lt","in":"query","required":false,"description":"Return accounts that have a `balance.available` less than this value.","schema":{"type":"number","description":"Return accounts that have a `balance.available` less than this value."}},{"name":"balance__available__lte","in":"query","required":false,"description":"Return accounts that have a `balance.available` less than or equal to this value.","schema":{"type":"number","description":"Return accounts that have a `balance.available` less than or equal to this value."}},{"name":"balance__available__gt","in":"query","required":false,"description":"Return accounts that have a `balance.available` greater than this value.","schema":{"type":"number","description":"Return accounts that have a `balance.available` greater than this value."}},{"name":"balance__available__gte","in":"query","required":false,"description":"Return accounts that have a `balance.available` greater than or equal to this value.","schema":{"type":"number","description":"Return accounts that have a `balance.available` greater than or equal to this value."}},{"name":"balance__available__range","in":"query","required":false,"description":"Return accounts that have a `balance.available` within a range of two values.","schema":{"type":"array","description":"Return accounts that have a `balance.available` within a range of two values."}},{"name":"balance__current","in":"query","required":false,"description":"Return accounts that have a `balance.current` matching exactly this value.","schema":{"type":"number","description":"Return accounts that have a `balance.current` matching exactly this value."}},{"name":"balance__current__lt","in":"query","required":false,"description":"Return accounts that have a `balance.current` less than this value.","schema":{"type":"number","description":"Return accounts that have a `balance.current` less than this value."}},{"name":"balance__current__lte","in":"query","required":false,"description":"Return accounts that have a `balance.available` less than or equal to this value.","schema":{"type":"number","description":"Return accounts that have a `balance.available` less than or equal to this value."}},{"name":"balance__current__gt","in":"query","required":false,"description":"Return accounts that have a `balance.current` greater than this value.","schema":{"type":"number","description":"Return accounts that have a `balance.current` greater than this value."}},{"name":"balance__current__gte","in":"query","required":false,"description":"Return accounts that have a `balance.available` greater than or equal to this value.","schema":{"type":"number","description":"Return accounts that have a `balance.available` greater than or equal to this value."}},{"name":"balance__current__range","in":"query","required":false,"description":"Return accounts that have a `balance.current` within a range of two values.","schema":{"type":"array","description":"Return accounts that have a `balance.current` within a range of two values."}},{"name":"category","in":"query","required":false,"description":"Return accounts only for the given category (for example, `CHECKING_ACCOUNT` and `SAVINGS_ACCOUNT`).","schema":{"type":"string","description":"Return accounts only for the given category (for example, `CHECKING_ACCOUNT` and `SAVINGS_ACCOUNT`)."}},{"name":"category__in","in":"query","required":false,"description":"Return accounts only for the given categories (for example, `CHECKING_ACCOUNT` and `SAVINGS_ACCOUNT`).","schema":{"type":"array","description":"Return accounts only for the given categories (for example, `CHECKING_ACCOUNT` and `SAVINGS_ACCOUNT`)."}},{"name":"created_at","in":"query","required":false,"description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__range","in":"query","required":false,"description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format).","schema":{"type":"array","description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format)."}},{"name":"currency","in":"query","required":false,"description":"Return results that hold finances or balances in only this three-letter currency code.","schema":{"type":"string","description":"Return results that hold finances or balances in only this three-letter currency code."}},{"name":"currency__in","in":"query","required":false,"description":"Return results that have funds or balances in one of these three-letter currency codes.","schema":{"type":"array","description":"Return results that have funds or balances in one of these three-letter currency codes."}},{"name":"id","in":"query","required":false,"description":"Return information only for this resource `id`.","schema":{"type":"string","description":"Return information only for this resource `id`."}},{"name":"id__in","in":"query","required":false,"description":"Return information for these resource `id`s.","schema":{"type":"array","description":"Return information for these resource `id`s."}},{"name":"institution","in":"query","required":false,"description":"Return results only for this institution (use the Belvo-designated name, such as `erebor_mx_retail`).","schema":{"type":"string","description":"Return results only for this institution (use the Belvo-designated name, such as `erebor_mx_retail`)."}},{"name":"institution__in","in":"query","required":false,"description":"Return results only for these institutions (use the Belvo-designated names, such as `erebor_mx_retail` and `gringotts_mx_retail`).","schema":{"type":"array","description":"Return results only for these institutions (use the Belvo-designated names, such as `erebor_mx_retail` and `gringotts_mx_retail`)."}},{"name":"name","in":"query","required":false,"description":"Return accounts with exactly this internal (specified by the institution) name.","schema":{"type":"string","description":"Return accounts with exactly this internal (specified by the institution) name."}},{"name":"name__icontains","in":"query","required":false,"description":"Return accounts partially matching this internal (specified by the institution) name.","schema":{"type":"string","description":"Return accounts partially matching this internal (specified by the institution) name."}},{"name":"number","in":"query","required":false,"description":"Return information only for this account number (as specified by the institution).","schema":{"type":"string","description":"Return information only for this account number (as specified by the institution)."}},{"name":"number__in","in":"query","required":false,"description":"Return information for these account numbers (as specified by the institution).","schema":{"type":"array","description":"Return information for these account numbers (as specified by the institution)."}},{"name":"public_identification_name","in":"query","required":false,"description":"Return information only for this type of account ID. For example, CLABE accounts.","schema":{"type":"string","description":"Return information only for this type of account ID. For example, CLABE accounts."}},{"name":"public_identification_value","in":"query","required":false,"description":"Return information only for this account ID. For example, the account number for a CLABE account.","schema":{"type":"string","description":"Return information only for this account ID. For example, the account number for a CLABE account."}},{"name":"type","in":"query","required":false,"description":"Return information only for accounts matching this account type, as designated by the institution.","schema":{"type":"string","description":"Return information only for accounts matching this account type, as designated by the institution."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/accounts-create-link-accounts":{"post":{"operationId":"payments_belvo_accounts_create_link_accounts","summary":"Retrieve accounts for a link","description":"POST /api/accounts","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/accounts-resume-retrieve-session":{"post":{"operationId":"payments_belvo_accounts_resume_retrieve_session","summary":"Complete an accounts request","description":"PATCH /api/accounts","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/accounts-get-details":{"get":{"operationId":"payments_belvo_accounts_get_details","summary":"Get an account's details","description":"GET /api/accounts/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `account.id` you want to get detailed information about.","schema":{"type":"string","description":"The `account.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/accounts-delete-specific-account":{"post":{"operationId":"payments_belvo_accounts_delete_specific_account","summary":"Delete an account","description":"DELETE /api/accounts/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `account.id` you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/transactions-list-all-transactions":{"get":{"operationId":"payments_belvo_transactions_list_all_transactions","summary":"List all transactions","description":"GET /api/transactions","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"link","in":"query","required":true,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"account","in":"query","required":false,"description":"The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve…","schema":{"type":"string","description":"The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve…"}},{"name":"account__in","in":"query","required":false,"description":"Return results only for these `account.id`s.","schema":{"type":"array","description":"Return results only for these `account.id`s."}},{"name":"account__balance__available","in":"query","required":false,"description":"Return transactions that have a `account.balance.available` matching exactly this value.","schema":{"type":"number","description":"Return transactions that have a `account.balance.available` matching exactly this value."}},{"name":"account__balance__available__lt","in":"query","required":false,"description":"Return transactions that have a `account.balance.available` less than this value.","schema":{"type":"number","description":"Return transactions that have a `account.balance.available` less than this value."}},{"name":"account__balance__available__lte","in":"query","required":false,"description":"Return transactions that have a `account.balance.available` less than or equal to this value.","schema":{"type":"number","description":"Return transactions that have a `account.balance.available` less than or equal to this value."}},{"name":"account__balance__available__gt","in":"query","required":false,"description":"Return transactions that have a `account.balance.available` more than this value.","schema":{"type":"number","description":"Return transactions that have a `account.balance.available` more than this value."}},{"name":"account__balance__available__gte","in":"query","required":false,"description":"Return transactions that have a `account.balance.available` more than or equal to this value.","schema":{"type":"number","description":"Return transactions that have a `account.balance.available` more than or equal to this value."}},{"name":"account__balance__available__range","in":"query","required":false,"description":"Return transactions that have a `account.balance.available` within a range of two values.","schema":{"type":"array","description":"Return transactions that have a `account.balance.available` within a range of two values."}},{"name":"account__balance__current","in":"query","required":false,"description":"Return transactions that have a `account.balance.current` matching exactly this value.","schema":{"type":"number","description":"Return transactions that have a `account.balance.current` matching exactly this value."}},{"name":"account__balance__current__gt","in":"query","required":false,"description":"Return transactions that have a `account.balance.current` greater than this value.","schema":{"type":"number","description":"Return transactions that have a `account.balance.current` greater than this value."}},{"name":"account__balance__current__gte","in":"query","required":false,"description":"Return transactions that have a `account.balance.current` greater than or equal to this value.","schema":{"type":"number","description":"Return transactions that have a `account.balance.current` greater than or equal to this value."}},{"name":"account__balance__current__lt","in":"query","required":false,"description":"Return transactions that have a `account.balance.current` less than this value.","schema":{"type":"number","description":"Return transactions that have a `account.balance.current` less than this value."}},{"name":"account__balance__current__lte","in":"query","required":false,"description":"Return transactions that have a `account.balance.current` less than or equal to this value.","schema":{"type":"number","description":"Return transactions that have a `account.balance.current` less than or equal to this value."}},{"name":"account__balance__current__range","in":"query","required":false,"description":"Return transactions that have a `account.balance.current` within a range of two values.","schema":{"type":"array","description":"Return transactions that have a `account.balance.current` within a range of two values."}},{"name":"account_type","in":"query","required":false,"description":"Return information only for transactions matching this account type, as designated by the institution.","schema":{"type":"string","description":"Return information only for transactions matching this account type, as designated by the institution."}},{"name":"account_type__in","in":"query","required":false,"description":"Return information only for transactions matching these account types, as designated by the institution.","schema":{"type":"array","description":"Return information only for transactions matching these account types, as designated by the institution."}},{"name":"accounting_date","in":"query","required":false,"description":"Return transactions that were processed by the institution on exactly this date (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return transactions that were processed by the institution on exactly this date (`YYYY-MM-DD`)."}},{"name":"accounting_date__gt","in":"query","required":false,"description":"Return transactions that were processed by the institution after this date (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return transactions that were processed by the institution after this date (`YYYY-MM-DD`)."}},{"name":"accounting_date__gte","in":"query","required":false,"description":"Return transactions that were processed by the institution on this date (`YYYY-MM-DD`) or later.","schema":{"type":"string","description":"Return transactions that were processed by the institution on this date (`YYYY-MM-DD`) or later."}},{"name":"accounting_date__lt","in":"query","required":false,"description":"Return transactions that were processed by the institution before this date (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return transactions that were processed by the institution before this date (`YYYY-MM-DD`)."}},{"name":"accounting_date__lte","in":"query","required":false,"description":"Return transactions that were processed by the institution on this date (`YYYY-MM-DD`) or earlier.","schema":{"type":"string","description":"Return transactions that were processed by the institution on this date (`YYYY-MM-DD`) or earlier."}},{"name":"accounting_date__range","in":"query","required":false,"description":"Return transactions that were processed by the institution in this date range (`YYYY-MM-DD`).","schema":{"type":"array","description":"Return transactions that were processed by the institution in this date range (`YYYY-MM-DD`)."}},{"name":"amount","in":"query","required":false,"description":"Return results only for this value.","schema":{"type":"number","description":"Return results only for this value."}},{"name":"amount__gt","in":"query","required":false,"description":"Return results only for more than this amount.","schema":{"type":"number","description":"Return results only for more than this amount."}},{"name":"amount__gte","in":"query","required":false,"description":"Return results only for and more than this amount.","schema":{"type":"number","description":"Return results only for and more than this amount."}},{"name":"amount__lt","in":"query","required":false,"description":"Return results only for less than this amount.","schema":{"type":"number","description":"Return results only for less than this amount."}},{"name":"amount__lte","in":"query","required":false,"description":"Return results only for this amount or less.","schema":{"type":"number","description":"Return results only for this amount or less."}},{"name":"amount__range","in":"query","required":false,"description":"Return results between this amount range.","schema":{"type":"array","description":"Return results between this amount range."}},{"name":"collected_at","in":"query","required":false,"description":"Return items that were retrieved from the institution on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp).","schema":{"type":"string","description":"Return items that were retrieved from the institution on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp)."}},{"name":"collected_at__gt","in":"query","required":false,"description":"Return items that were retrieved from the institution after this date (`YYYY-MM-DD` or full `ISO-8601` timestamp).","schema":{"type":"string","description":"Return items that were retrieved from the institution after this date (`YYYY-MM-DD` or full `ISO-8601` timestamp)."}},{"name":"collected_at__gte","in":"query","required":false,"description":"Return items that were retrieved from the institution after or on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp).","schema":{"type":"string","description":"Return items that were retrieved from the institution after or on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp)."}},{"name":"collected_at__lt","in":"query","required":false,"description":"Return items that were retrieved from the institution before this date (`YYYY-MM-DD` or full `ISO-8601` timestamp).","schema":{"type":"string","description":"Return items that were retrieved from the institution before this date (`YYYY-MM-DD` or full `ISO-8601` timestamp)."}},{"name":"collected_at__lte","in":"query","required":false,"description":"Return items that were retrieved from the institution before or on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp).","schema":{"type":"string","description":"Return items that were retrieved from the institution before or on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp)."}},{"name":"collected_at__range","in":"query","required":false,"description":"Return items that were retrieved from the institution between two dates (`YYYY-MM-DD` or full `ISO-8601` timestamp).","schema":{"type":"array","description":"Return items that were retrieved from the institution between two dates (`YYYY-MM-DD` or full `ISO-8601` timestamp)."}},{"name":"created_at","in":"query","required":false,"description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__range","in":"query","required":false,"description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format).","schema":{"type":"array","description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format)."}},{"name":"currency","in":"query","required":false,"description":"Return results that hold finances or balances in only this three-letter currency code.","schema":{"type":"string","description":"Return results that hold finances or balances in only this three-letter currency code."}},{"name":"currency__in","in":"query","required":false,"description":"Return results that have funds or balances in one of these three-letter currency codes.","schema":{"type":"array","description":"Return results that have funds or balances in one of these three-letter currency codes."}},{"name":"credit_card_data__bill_name__in","in":"query","required":false,"description":"Return transactions for one of these bill names.","schema":{"type":"array","description":"Return transactions for one of these bill names."}},{"name":"reference","in":"query","required":false,"description":"Returns transactions with this institution-assigned reference number.","schema":{"type":"string","description":"Returns transactions with this institution-assigned reference number."}},{"name":"reference__in","in":"query","required":false,"description":"Returns transactions with these institution-assigned reference numbers.","schema":{"type":"array","description":"Returns transactions with these institution-assigned reference numbers."}},{"name":"status","in":"query","required":false,"description":"Return transactions with this status. Can be either `PENDING`, `PROCESSED`, or `UNCATEGORIZED`.","schema":{"type":"string","description":"Return transactions with this status. Can be either `PENDING`, `PROCESSED`, or `UNCATEGORIZED`."}},{"name":"status__in","in":"query","required":false,"description":"Return transactions with these statuses. Can be either `PENDING`, `PROCESSED`, or `UNCATEGORIZED`.","schema":{"type":"array","description":"Return transactions with these statuses. Can be either `PENDING`, `PROCESSED`, or `UNCATEGORIZED`."}},{"name":"type","in":"query","required":false,"description":"Return transactions with this type. Can be either `INFLOW` or `OUTFLOW`.","schema":{"type":"string","description":"Return transactions with this type. Can be either `INFLOW` or `OUTFLOW`."}},{"name":"type__in","in":"query","required":false,"description":"Return transactions with this types. Can be either `INFLOW` or `OUTFLOW`.","schema":{"type":"array","description":"Return transactions with this types. Can be either `INFLOW` or `OUTFLOW`."}},{"name":"value_date","in":"query","required":false,"description":"Return results for exactly this date (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return results for exactly this date (`YYYY-MM-DD`)."}},{"name":"value_date__gt","in":"query","required":false,"description":"Return results that occurred after this date (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return results that occurred after this date (`YYYY-MM-DD`)."}},{"name":"value_date__gte","in":"query","required":false,"description":"Return results for this date (`YYYY-MM-DD`) or later.","schema":{"type":"string","description":"Return results for this date (`YYYY-MM-DD`) or later."}},{"name":"value_date__lt","in":"query","required":false,"description":"Return results for before this date (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return results for before this date (`YYYY-MM-DD`)."}},{"name":"value_date__lte","in":"query","required":false,"description":"Return results for this date (`YYYY-MM-DD`) or earlier.","schema":{"type":"string","description":"Return results for this date (`YYYY-MM-DD`) or earlier."}},{"name":"value_date__range","in":"query","required":false,"description":"Return results for this date (`YYYY-MM-DD`) range.","schema":{"type":"array","description":"Return results for this date (`YYYY-MM-DD`) range."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/transactions-create-link-transactions":{"post":{"operationId":"payments_belvo_transactions_create_link_transactions","summary":"Retrieve transactions for a link","description":"POST /api/transactions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"X-Belvo-Request-Mode":{"type":"string","enum":["async"],"description":"Recommended header parameter to make your POST request to retrieve transactions asynchronous (thus preventing timeouts). When you make a…"},"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/transactions-resume-retrieve-session":{"post":{"operationId":"payments_belvo_transactions_resume_retrieve_session","summary":"Complete a transactions request","description":"PATCH /api/transactions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/transactions-get-details":{"get":{"operationId":"payments_belvo_transactions_get_details","summary":"Get a transaction's details","description":"GET /api/transactions/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `transaction.id` you want to get detailed information about.","schema":{"type":"string","description":"The `transaction.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/transactions-remove-by-id":{"post":{"operationId":"payments_belvo_transactions_remove_by_id","summary":"Delete a transaction","description":"DELETE /api/transactions/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `transaction.id` that you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/balances-get-all":{"get":{"operationId":"payments_belvo_balances_get_all","summary":"List all balances","description":"GET /api/balances","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"account","in":"query","required":false,"description":"The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve…","schema":{"type":"string","description":"The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve…"}},{"name":"account__in","in":"query","required":false,"description":"Return results only for these `account.id`s.","schema":{"type":"array","description":"Return results only for these `account.id`s."}},{"name":"account__type","in":"query","required":false,"description":"Return information only for accounts matching this account type, as designated by the institution.","schema":{"type":"string","description":"Return information only for accounts matching this account type, as designated by the institution."}},{"name":"account__type__in","in":"query","required":false,"description":"Return information only for accounts matching these account types, as designated by the institution.","schema":{"type":"array","description":"Return information only for accounts matching these account types, as designated by the institution."}},{"name":"balance","in":"query","required":false,"description":"Return balances matching exactly this value.","schema":{"type":"number","description":"Return balances matching exactly this value."}},{"name":"balance__lt","in":"query","required":false,"description":"Return balances less than this value.","schema":{"type":"number","description":"Return balances less than this value."}},{"name":"balance__lte","in":"query","required":false,"description":"Return balances less than or equal to this value.","schema":{"type":"number","description":"Return balances less than or equal to this value."}},{"name":"balance__gt","in":"query","required":false,"description":"Return balances greater than this value.","schema":{"type":"number","description":"Return balances greater than this value."}},{"name":"balance__gte","in":"query","required":false,"description":"Return balances greater than or equal to this value.","schema":{"type":"number","description":"Return balances greater than or equal to this value."}},{"name":"balance__range","in":"query","required":false,"description":"Return balances between these two values.","schema":{"type":"array","description":"Return balances between these two values."}},{"name":"currency","in":"query","required":false,"description":"Return results that hold finances or balances in only this three-letter currency code.","schema":{"type":"string","description":"Return results that hold finances or balances in only this three-letter currency code."}},{"name":"currency__in","in":"query","required":false,"description":"Return results that have funds or balances in one of these three-letter currency codes.","schema":{"type":"array","description":"Return results that have funds or balances in one of these three-letter currency codes."}},{"name":"id","in":"query","required":false,"description":"Return information only for this resource `id`.","schema":{"type":"string","description":"Return information only for this resource `id`."}},{"name":"id__in","in":"query","required":false,"description":"Return information for these resource `id`s.","schema":{"type":"array","description":"Return information for these resource `id`s."}},{"name":"institution","in":"query","required":false,"description":"Return results only for this institution (use the Belvo-designated name, such as `erebor_mx_retail`).","schema":{"type":"string","description":"Return results only for this institution (use the Belvo-designated name, such as `erebor_mx_retail`)."}},{"name":"institution__in","in":"query","required":false,"description":"Return results only for these institutions (use the Belvo-designated names, such as `erebor_mx_retail` and `gringotts_mx_retail`).","schema":{"type":"array","description":"Return results only for these institutions (use the Belvo-designated names, such as `erebor_mx_retail` and `gringotts_mx_retail`)."}},{"name":"value_date","in":"query","required":false,"description":"Return results for exactly this date (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return results for exactly this date (`YYYY-MM-DD`)."}},{"name":"value_date__gt","in":"query","required":false,"description":"Return results that occurred after this date (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return results that occurred after this date (`YYYY-MM-DD`)."}},{"name":"value_date__gte","in":"query","required":false,"description":"Return results for this date (`YYYY-MM-DD`) or later.","schema":{"type":"string","description":"Return results for this date (`YYYY-MM-DD`) or later."}},{"name":"value_date__lt","in":"query","required":false,"description":"Return results for before this date (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return results for before this date (`YYYY-MM-DD`)."}},{"name":"value_date__lte","in":"query","required":false,"description":"Return results for this date (`YYYY-MM-DD`) or earlier.","schema":{"type":"string","description":"Return results for this date (`YYYY-MM-DD`) or earlier."}},{"name":"value_date__range","in":"query","required":false,"description":"Return results for this date (`YYYY-MM-DD`) range.","schema":{"type":"array","description":"Return results for this date (`YYYY-MM-DD`) range."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/balances-get-link-balances":{"post":{"operationId":"payments_belvo_balances_get_link_balances","summary":"Retrieve balances for a link","description":"POST /api/balances","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/balances-resume-session":{"post":{"operationId":"payments_belvo_balances_resume_session","summary":"Complete a balances request","description":"PATCH /api/balances","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/balances-get-details":{"get":{"operationId":"payments_belvo_balances_get_details","summary":"Get a balance's details","description":"GET /api/balances/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `balance.id` you want to get detailed information about.","schema":{"type":"string","description":"The `balance.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/balances-delete-balance":{"post":{"operationId":"payments_belvo_balances_delete_balance","summary":"Delete a balance","description":"DELETE /api/balances/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `balance.id` that you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/institutions-get-all":{"get":{"operationId":"payments_belvo_institutions_get_all","summary":"List all institutions","description":"GET /api/institutions","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"display_name","in":"query","required":false,"description":"Return institutions that partially match this display name.","schema":{"type":"string","description":"Return institutions that partially match this display name."}},{"name":"country_code","in":"query","required":false,"description":"Return institutions only for this two-letter country code.","schema":{"type":"string","description":"Return institutions only for this two-letter country code."}},{"name":"country_code__in","in":"query","required":false,"description":"Return institutions only for these two-letter country codes.","schema":{"type":"array","description":"Return institutions only for these two-letter country codes."}},{"name":"resources__allin","in":"query","required":false,"description":"Return institutions that support these resources.","schema":{"type":"array","description":"Return institutions that support these resources."}},{"name":"name","in":"query","required":false,"description":"Return an institution with this Belvo-designated name.","schema":{"type":"string","description":"Return an institution with this Belvo-designated name."}},{"name":"name__in","in":"query","required":false,"description":"Return institutions with one or more of these Belvo-designated names.","schema":{"type":"array","description":"Return institutions with one or more of these Belvo-designated names."}},{"name":"status","in":"query","required":false,"description":"Return institutions with the given status. You can choose between `healthy` or `down`.","schema":{"type":"string","description":"Return institutions with the given status. You can choose between `healthy` or `down`."}},{"name":"status__in","in":"query","required":false,"description":"Return institutions with one of the given statuses. You can choose between `healthy` or `down`.","schema":{"type":"array","description":"Return institutions with one of the given statuses. You can choose between `healthy` or `down`."}},{"name":"type","in":"query","required":false,"description":"Return institutions of this type. You can choose between `bank`, `fiscal`, or `employment`.","schema":{"type":"string","description":"Return institutions of this type. You can choose between `bank`, `fiscal`, or `employment`."}},{"name":"type__in","in":"query","required":false,"description":"Return institutions of one of these types. You can choose between `bank`, `fiscal`, or `employment`.","schema":{"type":"array","description":"Return institutions of one of these types. You can choose between `bank`, `fiscal`, or `employment`."}},{"name":"website","in":"query","required":false,"description":"Return institutions with this website URL.","schema":{"type":"string","description":"Return institutions with this website URL."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/institutions-get-details":{"get":{"operationId":"payments_belvo_institutions_get_details","summary":"Get an institution's details","description":"GET /api/institutions/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `institution.id` you want to get detailed information about.","schema":{"type":"string","description":"The `institution.id` you want to get detailed information about."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/owners-list-all":{"get":{"operationId":"payments_belvo_owners_list_all","summary":"List all owners","description":"GET /api/owners","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"id","in":"query","required":false,"description":"Return information only for this resource `id`.","schema":{"type":"string","description":"Return information only for this resource `id`."}},{"name":"id__in","in":"query","required":false,"description":"Return information for these resource `id`s.","schema":{"type":"array","description":"Return information for these resource `id`s."}},{"name":"created_at","in":"query","required":false,"description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__range","in":"query","required":false,"description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format).","schema":{"type":"array","description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format)."}},{"name":"email","in":"query","required":false,"description":"Returns owners whose email address match your query.","schema":{"type":"string","description":"Returns owners whose email address match your query."}},{"name":"display_name__icontains","in":"query","required":false,"description":"Return owners whose full display name partially matches your query. For example, `mar` will return results for Mark, Maria, Neymar,…","schema":{"type":"string","description":"Return owners whose full display name partially matches your query. For example, `mar` will return results for Mark, Maria, Neymar,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/owners-get-link-owner":{"post":{"operationId":"payments_belvo_owners_get_link_owner","summary":"Retrieve owners for a link","description":"POST /api/owners","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/owners-resume-retrieve-session":{"post":{"operationId":"payments_belvo_owners_resume_retrieve_session","summary":"Complete an owners request","description":"PATCH /api/owners","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/owners-get-details":{"get":{"operationId":"payments_belvo_owners_get_details","summary":"Get an owner's details","description":"GET /api/owners/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `owner.id` you want to get detailed information about.","schema":{"type":"string","description":"The `owner.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/owners-delete-owner":{"post":{"operationId":"payments_belvo_owners_delete_owner","summary":"Delete an owner","description":"DELETE /api/owners/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `owner.id` that you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/invoices-list-all":{"get":{"operationId":"payments_belvo_invoices_list_all","summary":"List all invoices","description":"GET /api/invoices","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"id","in":"query","required":false,"description":"Return information only for this resource `id`.","schema":{"type":"string","description":"Return information only for this resource `id`."}},{"name":"id__in","in":"query","required":false,"description":"Return information for these resource `id`s.","schema":{"type":"array","description":"Return information for these resource `id`s."}},{"name":"created_at","in":"query","required":false,"description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__range","in":"query","required":false,"description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format).","schema":{"type":"array","description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format)."}},{"name":"invoice_date","in":"query","required":false,"description":"Return invoices issued exactly on this date (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return invoices issued exactly on this date (`YYYY-MM-DD`)."}},{"name":"invoice_date__lt","in":"query","required":false,"description":"Return balances issued before this date (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return balances issued before this date (`YYYY-MM-DD`)."}},{"name":"invoice_date__lte","in":"query","required":false,"description":"Return balances issued on this date or earlier (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return balances issued on this date or earlier (`YYYY-MM-DD`)."}},{"name":"invoice_date__gt","in":"query","required":false,"description":"Return invoices issued after this date (`YYYY-MM-DD`).","schema":{"type":"string","description":"Return invoices issued after this date (`YYYY-MM-DD`)."}},{"name":"invoice_date__gte","in":"query","required":false,"description":"Return invoices issued on this date or later (`YYYY-MM-DD`)","schema":{"type":"string","description":"Return invoices issued on this date or later (`YYYY-MM-DD`)"}},{"name":"invoice_date__range","in":"query","required":false,"description":"Return invoices issued within this date range (`YYYY-MM-DD`).","schema":{"type":"array","description":"Return invoices issued within this date range (`YYYY-MM-DD`)."}},{"name":"invoice_identification","in":"query","required":false,"description":"Return an invoice with this ID (as provided by the insitution).","schema":{"type":"string","description":"Return an invoice with this ID (as provided by the insitution)."}},{"name":"invoice_identification__in","in":"query","required":false,"description":"Return invoices with these IDs (as provided by the institution).","schema":{"type":"array","description":"Return invoices with these IDs (as provided by the institution)."}},{"name":"status","in":"query","required":false,"description":"Return invoices with this status. Can be either `Vigente` (valid) or `Cancelado` (cancelled).","schema":{"type":"string","description":"Return invoices with this status. Can be either `Vigente` (valid) or `Cancelado` (cancelled)."}},{"name":"status__in","in":"query","required":false,"description":"Return invoices with these statuses. Can be either `Vigente` (valid) or `Cancelado` (cancelled).","schema":{"type":"array","description":"Return invoices with these statuses. Can be either `Vigente` (valid) or `Cancelado` (cancelled)."}},{"name":"type","in":"query","required":false,"description":"Return invoices of this type. Can be either `OUTFLOW` or `INFLOW`.","schema":{"type":"string","description":"Return invoices of this type. Can be either `OUTFLOW` or `INFLOW`."}},{"name":"type__in","in":"query","required":false,"description":"Return invoices of these types. Can be either `OUTFLOW` or `INFLOW`.","schema":{"type":"array","description":"Return invoices of these types. Can be either `OUTFLOW` or `INFLOW`."}},{"name":"total_amount","in":"query","required":false,"description":"Return invoices matching exactly this value.","schema":{"type":"number","description":"Return invoices matching exactly this value."}},{"name":"total_amount__lt","in":"query","required":false,"description":"Return invoices less than this value.","schema":{"type":"number","description":"Return invoices less than this value."}},{"name":"total_amount__lte","in":"query","required":false,"description":"Return invoices less than or equal to this value.","schema":{"type":"number","description":"Return invoices less than or equal to this value."}},{"name":"total_amount__gt","in":"query","required":false,"description":"Return invoices greater than this value.","schema":{"type":"number","description":"Return invoices greater than this value."}},{"name":"total_amount__gte","in":"query","required":false,"description":"Return invoices greater than or equal to this value.","schema":{"type":"number","description":"Return invoices greater than or equal to this value."}},{"name":"total_amount__range","in":"query","required":false,"description":"Return invoices between these two values.","schema":{"type":"array","description":"Return invoices between these two values."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/invoices-get-link-invoices":{"post":{"operationId":"payments_belvo_invoices_get_link_invoices","summary":"Retrieve invoices for a link","description":"POST /api/invoices","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"X-Belvo-Request-Mode":{"type":"string","enum":["async"],"description":"Recommended header parameter to make your POST request to retrieve invoices asynchronous (thus preventing timeouts). When you make a…"},"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/invoices-complete-request":{"post":{"operationId":"payments_belvo_invoices_complete_request","summary":"Complete an invoices request","description":"PATCH /api/invoices","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/invoices-get-details":{"get":{"operationId":"payments_belvo_invoices_get_details","summary":"Get an invoice's details","description":"GET /api/invoices/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `invoice.id` you want to get detailed information about.","schema":{"type":"string","description":"The `invoice.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/invoices-delete-invoice":{"post":{"operationId":"payments_belvo_invoices_delete_invoice","summary":"Delete an invoice","description":"DELETE /api/invoices/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `invoice.id` that you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-returns-list-all":{"get":{"operationId":"payments_belvo_tax_returns_list_all","summary":"List all tax returns","description":"GET /api/tax-returns","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"id","in":"query","required":false,"description":"Return information only for this resource `id`.","schema":{"type":"string","description":"Return information only for this resource `id`."}},{"name":"id__in","in":"query","required":false,"description":"Return information for these resource `id`s.","schema":{"type":"array","description":"Return information for these resource `id`s."}},{"name":"created_at","in":"query","required":false,"description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__range","in":"query","required":false,"description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format).","schema":{"type":"array","description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format)."}},{"name":"ejercicio","in":"query","required":false,"description":"Return tax returns for exactly this year (`YYYY`).","schema":{"type":"string","description":"Return tax returns for exactly this year (`YYYY`)."}},{"name":"ejercicio__lt","in":"query","required":false,"description":"Return tax returns for before this year (`YYYY`).","schema":{"type":"string","description":"Return tax returns for before this year (`YYYY`)."}},{"name":"ejercicio__lte","in":"query","required":false,"description":"Return tax returns for this year and earlier (`YYYY`).","schema":{"type":"string","description":"Return tax returns for this year and earlier (`YYYY`)."}},{"name":"ejercicio__gt","in":"query","required":false,"description":"Return tax returns for after this year (`YYYY`).","schema":{"type":"string","description":"Return tax returns for after this year (`YYYY`)."}},{"name":"ejercicio__gte","in":"query","required":false,"description":"Return tax returns for this year or later (`YYYY`).","schema":{"type":"string","description":"Return tax returns for this year or later (`YYYY`)."}},{"name":"ejercicio__range","in":"query","required":false,"description":"Return tax returns for this range of years (`YYYY`).","schema":{"type":"array","description":"Return tax returns for this range of years (`YYYY`)."}},{"name":"tipo_declaracion","in":"query","required":false,"description":"Return tax returns with this declaration type.","schema":{"type":"string","description":"Return tax returns with this declaration type."}},{"name":"tipo_declaracion__in","in":"query","required":false,"description":"Return tax returns with these declaration types.","schema":{"type":"array","description":"Return tax returns with these declaration types."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-returns-get-information":{"post":{"operationId":"payments_belvo_tax_returns_get_information","summary":"Retrieve tax returns for a link","description":"POST /api/tax-returns","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-returns-get-details":{"get":{"operationId":"payments_belvo_tax_returns_get_details","summary":"Get a tax return's details","description":"GET /api/tax-returns/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `tax-return.id` you want to get detailed information about.","schema":{"type":"string","description":"The `tax-return.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-returns-delete-specific-tax-return":{"post":{"operationId":"payments_belvo_tax_returns_delete_specific_tax_return","summary":"Delete a tax return","description":"DELETE /api/tax-returns/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the tax return you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-status-list-all":{"get":{"operationId":"payments_belvo_tax_status_list_all","summary":"List all tax statuses","description":"GET /api/tax-status","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"id","in":"query","required":false,"description":"Return information only for this resource `id`.","schema":{"type":"string","description":"Return information only for this resource `id`."}},{"name":"id__in","in":"query","required":false,"description":"Return information for these resource `id`s.","schema":{"type":"array","description":"Return information for these resource `id`s."}},{"name":"created_at","in":"query","required":false,"description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__range","in":"query","required":false,"description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format).","schema":{"type":"array","description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-status-get-link-tax-status":{"post":{"operationId":"payments_belvo_tax_status_get_link_tax_status","summary":"Retrieve tax statuses for a link","description":"POST /api/tax-status","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-status-get-details":{"get":{"operationId":"payments_belvo_tax_status_get_details","summary":"Get a tax status's details","description":"GET /api/tax-status/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `tax-status.id` you want to get detailed information about.","schema":{"type":"string","description":"The `tax-status.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-status-delete-specific-tax-status":{"post":{"operationId":"payments_belvo_tax_status_delete_specific_tax_status","summary":"Delete a tax status","description":"DELETE /api/tax-status/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"the `tax-status.id` that you want to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-compliance-status-list-all":{"get":{"operationId":"payments_belvo_tax_compliance_status_list_all","summary":"List all tax compliance statuses","description":"GET /api/tax-compliance-status","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"id","in":"query","required":false,"description":"Return information only for this resource `id`.","schema":{"type":"string","description":"Return information only for this resource `id`."}},{"name":"id__in","in":"query","required":false,"description":"Return information for these resource `id`s.","schema":{"type":"array","description":"Return information for these resource `id`s."}},{"name":"created_at","in":"query","required":false,"description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__range","in":"query","required":false,"description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format).","schema":{"type":"array","description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-compliance-status-get-fiscal-link-info":{"post":{"operationId":"payments_belvo_tax_compliance_status_get_fiscal_link_info","summary":"Retrieve tax compliance statuses for a link","description":"POST /api/tax-compliance-status","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-compliance-status-get-details":{"get":{"operationId":"payments_belvo_tax_compliance_status_get_details","summary":"Get a tax compliance status's details","description":"GET /api/tax-compliance-status/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `tax-compliance-status.id` you want to get detailed information about.","schema":{"type":"string","description":"The `tax-compliance-status.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-compliance-status-delete-specific-tax-compliance-status":{"post":{"operationId":"payments_belvo_tax_compliance_status_delete_specific_tax_compliance_status","summary":"Delete a tax compliance status","description":"DELETE /api/tax-compliance-status/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `tax-compliance-status.id` that you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/incomes-list-all":{"get":{"operationId":"payments_belvo_incomes_list_all","summary":"List all incomes","description":"GET /api/incomes","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"account","in":"query","required":false,"description":"The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve…","schema":{"type":"string","description":"The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve…"}},{"name":"account__in","in":"query","required":false,"description":"Return results only for these `account.id`s.","schema":{"type":"array","description":"Return results only for these `account.id`s."}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/incomes-get-insights":{"post":{"operationId":"payments_belvo_incomes_get_insights","summary":"Retrieve incomes for a link","description":"POST /api/incomes","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/incomes-resume-session":{"post":{"operationId":"payments_belvo_incomes_resume_session","summary":"Complete an incomes request","description":"PATCH /api/incomes","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/incomes-get-details":{"get":{"operationId":"payments_belvo_incomes_get_details","summary":"Get an income's details","description":"GET /api/incomes/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `income.id` you want to get detailed information about.","schema":{"type":"string","description":"The `income.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/incomes-delete-income":{"post":{"operationId":"payments_belvo_incomes_delete_income","summary":"Delete an income","description":"DELETE /api/incomes/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"the `income.id` that you want to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/recurring-expenses-list-all":{"get":{"operationId":"payments_belvo_recurring_expenses_list_all","summary":"List all recurring expenses","description":"GET /api/recurring-expenses","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"account","in":"query","required":false,"description":"The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve…","schema":{"type":"string","description":"The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve…"}},{"name":"account__in","in":"query","required":false,"description":"Return results only for these `account.id`s.","schema":{"type":"array","description":"Return results only for these `account.id`s."}},{"name":"id","in":"query","required":false,"description":"Return information only for this resource `id`.","schema":{"type":"string","description":"Return information only for this resource `id`."}},{"name":"id__in","in":"query","required":false,"description":"Return information for these resource `id`s.","schema":{"type":"array","description":"Return information for these resource `id`s."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/recurring-expenses-get-insights":{"post":{"operationId":"payments_belvo_recurring_expenses_get_insights","summary":"Retrieve recurring expenses for a link","description":"POST /api/recurring-expenses","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/recurring-expenses-resume-request":{"post":{"operationId":"payments_belvo_recurring_expenses_resume_request","summary":"Complete a recurring expenses request","description":"PATCH /api/recurring-expenses","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/recurring-expenses-get-details":{"get":{"operationId":"payments_belvo_recurring_expenses_get_details","summary":"Get a recurring expense's details","description":"GET /api/recurring-expenses/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `recurring-expenses.id` you want to get detailed information about.","schema":{"type":"string","description":"The `recurring-expenses.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/recurring-expenses-delete-expense":{"post":{"operationId":"payments_belvo_recurring_expenses_delete_expense","summary":"Delete a recurring expense","description":"DELETE /api/recurring-expenses/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `recurring-expenses.id` that you want to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/risk-insights-list-all-risk-insights":{"get":{"operationId":"payments_belvo_risk_insights_list_all_risk_insights","summary":"List all risk insights","description":"GET /api/risk-insights","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"account","in":"query","required":false,"description":"The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve…","schema":{"type":"string","description":"The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve…"}},{"name":"account__in","in":"query","required":false,"description":"Return results only for these `account.id`s.","schema":{"type":"array","description":"Return results only for these `account.id`s."}},{"name":"id","in":"query","required":false,"description":"Return information only for this resource `id`.","schema":{"type":"string","description":"Return information only for this resource `id`."}},{"name":"id__in","in":"query","required":false,"description":"Return information for these resource `id`s.","schema":{"type":"array","description":"Return information for these resource `id`s."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/risk-insights-get-for-link":{"post":{"operationId":"payments_belvo_risk_insights_get_for_link","summary":"Retrieve risk insights for a link","description":"POST /api/risk-insights","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/risk-insights-resume-insights-session":{"post":{"operationId":"payments_belvo_risk_insights_resume_insights_session","summary":"Complete a risk insights request","description":"PATCH /api/risk-insights","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/risk-insights-get-details":{"get":{"operationId":"payments_belvo_risk_insights_get_details","summary":"Get a risk insight's details","description":"GET /api/risk-insights/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `risk-insights.id` you want to get detailed information about.","schema":{"type":"string","description":"The `risk-insights.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/risk-insights-delete-specific-insight":{"post":{"operationId":"payments_belvo_risk_insights_delete_specific_insight","summary":"Delete a risk insight","description":"DELETE /api/risk-insights/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `risk-insights.id` that you want to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-retentions-list-all":{"get":{"operationId":"payments_belvo_tax_retentions_list_all","summary":"List all tax retentions","description":"GET /api/tax-retentions","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"created_at","in":"query","required":false,"description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__range","in":"query","required":false,"description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format).","schema":{"type":"array","description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-retentions-get-link-tax-retentions":{"post":{"operationId":"payments_belvo_tax_retentions_get_link_tax_retentions","summary":"Retrieve tax retentions for a link","description":"POST /api/tax-retentions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-retentions-get-details":{"get":{"operationId":"payments_belvo_tax_retentions_get_details","summary":"Get a tax retention's details","description":"GET /api/tax-retentions/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `tax-retention.id` you want to get detailed information about.","schema":{"type":"string","description":"The `tax-retention.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-retentions-delete-specific-tax-retention":{"post":{"operationId":"payments_belvo_tax_retentions_delete_specific_tax_retention","summary":"Delete a tax retention","description":"DELETE /api/tax-retentions/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `tax-retention.id` that you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-declarations-list-all":{"get":{"operationId":"payments_belvo_tax_declarations_list_all","summary":"List all tax declarations","description":"GET /api/tax-declarations","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"id","in":"query","required":false,"description":"Return information only for this resource `id`.","schema":{"type":"string","description":"Return information only for this resource `id`."}},{"name":"id__in","in":"query","required":false,"description":"Return information for these resource `id`s.","schema":{"type":"array","description":"Return information for these resource `id`s."}},{"name":"created_at","in":"query","required":false,"description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__range","in":"query","required":false,"description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format).","schema":{"type":"array","description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format)."}},{"name":"year","in":"query","required":false,"description":"Return results for this year (`YYYY`).","schema":{"type":"number","description":"Return results for this year (`YYYY`)."}},{"name":"year__gt","in":"query","required":false,"description":"Return results for after this year (`YYYY`).","schema":{"type":"number","description":"Return results for after this year (`YYYY`)."}},{"name":"year__gte","in":"query","required":false,"description":"Return results for this year or after (`YYYY`).","schema":{"type":"number","description":"Return results for this year or after (`YYYY`)."}},{"name":"year__lt","in":"query","required":false,"description":"Return results for before this year (`YYYY`).","schema":{"type":"number","description":"Return results for before this year (`YYYY`)."}},{"name":"year__lte","in":"query","required":false,"description":"Return results for this year or earlier (`YYYY`).","schema":{"type":"number","description":"Return results for this year or earlier (`YYYY`)."}},{"name":"year__range","in":"query","required":false,"description":"Return results between these two years (`YYYY`).","schema":{"type":"array","description":"Return results between these two years (`YYYY`)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-declarations-get-fiscal-link":{"post":{"operationId":"payments_belvo_tax_declarations_get_fiscal_link","summary":"Retrieve tax declarations for a link","description":"POST /api/tax-declarations","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-declarations-get-details":{"get":{"operationId":"payments_belvo_tax_declarations_get_details","summary":"Get a tax declaration's details","description":"GET /api/tax-declarations/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `tax-declaration.id` you want to get detailed information about.","schema":{"type":"string","description":"The `tax-declaration.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/tax-declarations-delete-specific-declaration":{"post":{"operationId":"payments_belvo_tax_declarations_delete_specific_declaration","summary":"Delete a tax declration","description":"DELETE /api/tax-declarations/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `tax-declration.id` that you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/employment-records-mexico-list-all":{"get":{"operationId":"payments_belvo_employment_records_mexico_list_all","summary":"List all employment records","description":"GET /api/employment-records","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"id","in":"query","required":false,"description":"Return information only for this resource `id`.","schema":{"type":"string","description":"Return information only for this resource `id`."}},{"name":"id__in","in":"query","required":false,"description":"Return information for these resource `id`s.","schema":{"type":"array","description":"Return information for these resource `id`s."}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}},{"name":"internal_identification","in":"query","required":false,"description":"The `internal_identification` you want to filter by.","schema":{"type":"string","description":"The `internal_identification` you want to filter by."}},{"name":"internal_identification__in","in":"query","required":false,"description":"One or more `internal_identification`s you want to filter by.","schema":{"type":"array","description":"One or more `internal_identification`s you want to filter by."}},{"name":"collected_at","in":"query","required":false,"description":"Return items that were retrieved from the institution on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp).","schema":{"type":"string","description":"Return items that were retrieved from the institution on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp)."}},{"name":"collected_at__gt","in":"query","required":false,"description":"Return items that were retrieved from the institution after this date (`YYYY-MM-DD` or full `ISO-8601` timestamp).","schema":{"type":"string","description":"Return items that were retrieved from the institution after this date (`YYYY-MM-DD` or full `ISO-8601` timestamp)."}},{"name":"collected_at__gte","in":"query","required":false,"description":"Return items that were retrieved from the institution after or on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp).","schema":{"type":"string","description":"Return items that were retrieved from the institution after or on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp)."}},{"name":"collected_at__lt","in":"query","required":false,"description":"Return items that were retrieved from the institution before this date (`YYYY-MM-DD` or full `ISO-8601` timestamp).","schema":{"type":"string","description":"Return items that were retrieved from the institution before this date (`YYYY-MM-DD` or full `ISO-8601` timestamp)."}},{"name":"collected_at__lte","in":"query","required":false,"description":"Return items that were retrieved from the institution before or on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp).","schema":{"type":"string","description":"Return items that were retrieved from the institution before or on this date (`YYYY-MM-DD` or full `ISO-8601` timestamp)."}},{"name":"collected_at__range","in":"query","required":false,"description":"Return items that were retrieved from the institution between two dates (`YYYY-MM-DD` or full `ISO-8601` timestamp).","schema":{"type":"array","description":"Return items that were retrieved from the institution between two dates (`YYYY-MM-DD` or full `ISO-8601` timestamp)."}},{"name":"created_at","in":"query","required":false,"description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__gte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database after or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lt","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__lte","in":"query","required":false,"description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format).","schema":{"type":"string","description":"Return items that were last updated in Belvo's database before or on this date (in `YYYY-MM-DD` format)."}},{"name":"created_at__range","in":"query","required":false,"description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format).","schema":{"type":"array","description":"Return accounts that were last updated in Belvo's database between two dates (in `YYYY-MM-DD` format)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/employment-records-mexico-get-details":{"post":{"operationId":"payments_belvo_employment_records_mexico_get_details","summary":"Retrieve employment record details","description":"POST /api/employment-records","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/employment-records-mexico-get-details-2":{"get":{"operationId":"payments_belvo_employment_records_mexico_get_details_2","summary":"Get an employment record's details","description":"GET /api/employment-records/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `employment-record.id` you want to get detailed information about.","schema":{"type":"string","description":"The `employment-record.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/employment-records-mexico-delete-record":{"post":{"operationId":"payments_belvo_employment_records_mexico_delete_record","summary":"Delete an employment record","description":"DELETE /api/employment-records/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The `employment-record.id` that you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/income-verification-enrich-user-incomes":{"post":{"operationId":"payments_belvo_income_verification_enrich_user_incomes","summary":"Verify incomes","description":"POST /api/enrich/incomes","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/categorization-categorize-transactions":{"post":{"operationId":"payments_belvo_categorization_categorize_transactions","summary":"Categorize transactions","description":"POST /api/categorization","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/credit-score-list-all":{"get":{"operationId":"payments_belvo_credit_score_list_all","summary":"List all credit scores","description":"GET /api/credit-score","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"A page number within the paginated result set.","schema":{"type":"integer","description":"A page number within the paginated result set."}},{"name":"page_size","in":"query","required":false,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…","schema":{"type":"integer","default":100,"description":"Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per…"}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}},{"name":"account","in":"query","required":false,"description":"The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve…","schema":{"type":"string","description":"The `account.id` you want to filter by. ℹ️ We highly recommend adding either the `link.id` or the `account.id` filters in order to improve…"}},{"name":"account__in","in":"query","required":false,"description":"Return results only for these `account.id`s.","schema":{"type":"array","description":"Return results only for these `account.id`s."}},{"name":"link","in":"query","required":false,"description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance.","schema":{"type":"string","description":"The `link.id` you want to filter by. ℹ️ We highly recommend adding the `link.id` filter in order to improve your performance."}},{"name":"link__in","in":"query","required":false,"description":"Return results only for these `link.id`s.","schema":{"type":"array","description":"Return results only for these `link.id`s."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/credit-score-get-by-link":{"post":{"operationId":"payments_belvo_credit_score_get_by_link","summary":"Retrieve a credit score for a link","description":"POST /api/credit-score","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"omit":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"},"fields":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/credit-score-get-details-by-id":{"get":{"operationId":"payments_belvo_credit_score_get_details_by_id","summary":"Get a credit score's details","description":"GET /api/credit-score/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The `credit-score.id` you want to get detailed information about.","schema":{"type":"string","description":"The `credit-score.id` you want to get detailed information about."}},{"name":"omit","in":"query","required":false,"description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Omit certain fields from being returned in the response. For more information, see our [Filtering…"}},{"name":"fields","in":"query","required":false,"description":"Return only the specified fields in the response. For more information, see our [Filtering…","schema":{"type":"string","description":"Return only the specified fields in the response. For more information, see our [Filtering…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:belvo/credit-score-delete-specific-score":{"post":{"operationId":"payments_belvo_credit_score_delete_specific_score","summary":"Delete a credit score","description":"DELETE /api/credit-score/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"the `credit-score.id` that you want to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:belvo/credit-score-eyod-get-user-credit-score":{"post":{"operationId":"payments_belvo_credit_score_eyod_get_user_credit_score","summary":"Retrieve Credit Score","description":"POST /api/enrich/credit-score","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}