### GET /v1/account_settings/{account_id} Source: https://app.stainless.com/api/spec/documented/straddle/openapi.documented.yml Get all resolved settings for the specified account, including inherited values from organization, platform, and system defaults. ```markdown ### Parameters - **account_id** (string (uuid), path, required) - **request-id** (string, header, optional): Optional client generated identifier to trace and debug a request. - **correlation-id** (string, header, optional): Optional client generated identifier to trace and debug a series of requests. ### Responses #### 200 - OK **ItemResponseOfAccountSettingsV1** - **meta** (object) (required): Metadata about the API request, including an identifier and timestamp. - **api_request_id** (string (uuid)) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string (date-time)) (required): Timestamp for this API request, useful for troubleshooting. - **response_type** (string (object|array|error|none)) (required): Indicates the type of data returned. ("object"|"array"|"error"|"none") - **data** (object) (required) - **charges** (object) (required) - **max_amount** (integer (int64)) (required) - **monthly_amount** (integer (int64)) (required) - **daily_amount** (integer (int64)) (required) - **monthly_count** (integer (int64)) (required) - **funding_time** (string) - **linked_bank_account_id** (string) - **payouts** (object) (required) - **statement_settings** (object) (required) - **company_name** (string) - **company_id** (string) - **default_descriptor** (string) - **payment_types** (object) (required) - **charges** (string (active|inactive)) (required) ("active"|"inactive") - **payouts** (string (active|inactive)) (required) ("active"|"inactive") - **customer_types** (object) (required) - **individuals** (string (active|inactive)) (required) ("active"|"inactive") - **businesses** (string (active|inactive)) (required) ("active"|"inactive") - **consent_types** (object) (required) - **internet** (string (active|inactive)) (required) ("active"|"inactive") - **signed_agreement** (string (active|inactive)) (required) ("active"|"inactive") - **configuration** (object) (required) - **allow_data_unmask** (boolean) (required) - **allow_duplicate_email** (boolean) (required) - **allow_customer_identity_skip** (boolean) (required) - **allow_paykey_verification_skip** (boolean) (required) **ItemResponseOfAccountSettingsV1** **ItemResponseOfAccountSettingsV1** #### 400 - Bad Request **HttpServiceResponse** - **meta** (object) (required) - **api_request_id** (string) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string) (required): Timestamp for this API request, useful for troubleshooting. - **page_number** (integer (int32)): The page number to return results for. - **page_size** (integer (int32)): The number of results to return per page. - **total_rows** (integer (int32)): The total number of results available. - **sort_order** (string) (required): The order in which to sort the results. - **sort_by** (string) (required): The field to sort the results by. - **response_type** (string (object|array|error)) (required) ("object"|"array"|"error") - **data** (unknown) - **error** (object) - **status** (integer (int32)) (required) - **type** (string) (required) - **title** (string) (required) - **detail** (string) (required) - **items** (array (ErrorItemDto)) (required) Array items: - **reference** (string) (required) - **detail** (string) (required) **HttpServiceResponse** **HttpServiceResponse** #### 401 - Unauthorized **HttpServiceResponse** - **meta** (object) (required) - **api_request_id** (string) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string) (required): Timestamp for this API request, useful for troubleshooting. - **page_number** (integer (int32)): The page number to return results for. - **page_size** (integer (int32)): The number of results to return per page. - **total_rows** (integer (int32)): The total number of results available. - **sort_order** (string) (required): The order in which to sort the results. - **sort_by** (string) (required): The field to sort the results by. - **response_type** (string (object|array|error)) (required) ("object"|"array"|"error") - **data** (unknown) - **error** (object) - **status** (integer (int32)) (required) - **type** (string) (required) - **title** (string) (required) - **detail** (string) (required) - **items** (array (ErrorItemDto)) (required) Array items: - **reference** (string) (required) - **detail** (string) (required) **HttpServiceResponse** **HttpServiceResponse** #### 403 - Forbidden **HttpServiceResponse** - **meta** (object) (required) - **api_request_id** (string) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string) (required): Timestamp for this API request, useful for troubleshooting. - **page_number** (integer (int32)): The page number to return results for. - **page_size** (integer (int32)): The number of results to return per page. - **total_rows** (integer (int32)): The total number of results available. - **sort_order** (string) (required): The order in which to sort the results. - **sort_by** (string) (required): The field to sort the results by. - **response_type** (string (object|array|error)) (required) ("object"|"array"|"error") - **data** (unknown) - **error** (object) - **status** (integer (int32)) (required) - **type** (string) (required) - **title** (string) (required) - **detail** (string) (required) - **items** (array (ErrorItemDto)) (required) Array items: - **reference** (string) (required) - **detail** (string) (required) **HttpServiceResponse** **HttpServiceResponse** #### 404 - Not Found **HttpServiceResponse** - **meta** (object) (required) - **api_request_id** (string) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string) (required): Timestamp for this API request, useful for troubleshooting. - **page_number** (integer (int32)): The page number to return results for. - **page_size** (integer (int32)): The number of results to return per page. - **total_rows** (integer (int32)): The total number of results available. - **sort_order** (string) (required): The order in which to sort the results. - **sort_by** (string) (required): The field to sort the results by. - **response_type** (string (object|array|error)) (required) ("object"|"array"|"error") - **data** (unknown) - **error** (object) - **status** (integer (int32)) (required) - **type** (string) (required) - **title** (string) (required) - **detail** (string) (required) - **items** (array (ErrorItemDto)) (required) Array items: - **reference** (string) (required) - **detail** (string) (required) **HttpServiceResponse** **HttpServiceResponse** #### 422 - Validation Failed **HttpServiceResponse** - **meta** (object) (required) - **api_request_id** (string) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string) (required): Timestamp for this API request, useful for troubleshooting. - **page_number** (integer (int32)): The page number to return results for. - **page_size** (integer (int32)): The number of results to return per page. - **total_rows** (integer (int32)): The total number of results available. - **sort_order** (string) (required): The order in which to sort the results. - **sort_by** (string) (required): The field to sort the results by. - **response_type** (string (object|array|error)) (required) ("object"|"array"|"error") - **data** (unknown) - **error** (object) - **status** (integer (int32)) (required) - **type** (string) (required) - **title** (string) (required) - **detail** (string) (required) - **items** (array (ErrorItemDto)) (required) Array items: - **reference** (string) (required) - **detail** (string) (required) **HttpServiceResponse** **HttpServiceResponse** #### 500 - Server Error **HttpServiceResponse** - **meta** (object) (required) - **api_request_id** (string) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string) (required): Timestamp for this API request, useful for troubleshooting. - **page_number** (integer (int32)): The page number to return results for. - **page_size** (integer (int32)): The number of results to return per page. - **total_rows** (integer (int32)): The total number of results available. - **sort_order** (string) (required): The order in which to sort the results. - **sort_by** (string) (required): The field to sort the results by. - **response_type** (string (object|array|error)) (required) ("object"|"array"|"error") - **data** (unknown) - **error** (object) - **status** (integer (int32)) (required) - **type** (string) (required) - **title** (string) (required) - **detail** (string) (required) - **items** (array (ErrorItemDto)) (required) Array items: - **reference** (string) (required) - **detail** (string) (required) **HttpServiceResponse** **HttpServiceResponse** ### Example Usage ```bash curl -X GET "https://{environment}.straddle.com/v1/account_settings/{account_id}" ``` ``` -------------------------------- ### GET /v1/paykeys/{id}/review Source: https://app.stainless.com/api/spec/documented/straddle/openapi.documented.yml Get additional details about a paykey. ```markdown ### Parameters - **id** (string (uuid), path, required) - **Straddle-Account-Id** (string (uuid), header, optional): For use by platforms to specify an account id and set scope of a request. - **Request-Id** (string, header, optional): Optional client generated identifier to trace and debug a request. - **Correlation-Id** (string, header, optional): Optional client generated identifier to trace and debug a series of requests. ### Responses #### 200 - OK **PaykeyReviewV1ItemResponse** - **meta** (object) (required): Metadata about the API request, including an identifier and timestamp. - **api_request_id** (string (uuid)) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string (date-time)) (required): Timestamp for this API request, useful for troubleshooting. - **response_type** (string (object|array|error|none)) (required): Indicates the structure of the returned content. - "object" means the `data` field contains a single JSON object. - "array" means the `data` field contains an array of objects. - "error" means the `data` field contains an error object with details of the issue. - "none" means no data is returned. ("object"|"array"|"error"|"none") - **data** (object) (required) - **paykey_details** (object) (required) - **id** (string (uuid)) (required): Unique identifier for the paykey. - **customer_id** (string (uuid)): Unique identifier of the related customer object. - **label** (string) (required): Human-readable label used to represent this paykey in a UI. - **source** (string (bank_account|straddle|mx|plaid|tan|quiltt)) (required) ("bank_account"|"straddle"|"mx"|"plaid"|"tan"|"quiltt") - **institution_name** (string): Name of the financial institution. (example: "Bank of America") - **status** (string (pending|active|inactive|rejected|review|blocked)) (required) ("pending"|"active"|"inactive"|"rejected"|"review"|"blocked") - **status_details** (object) - **message** (string) (required): A human-readable description of the current status. (example: "Bank account sucesfully validated") - **reason** (string (insufficient_funds|closed_bank_account|invalid_bank_account|invalid_routing|disputed|payment_stopped|owner_deceased|frozen_bank_account|risk_review|fraudulent|duplicate_entry|invalid_paykey|payment_blocked|amount_too_large|too_many_attempts|internal_system_error|user_request|ok|other_network_return|payout_refused|cancel_request|failed_verification|require_review|blocked_by_system|watchtower_review|validating|auto_hold)) (required) ("insufficient_funds"|"closed_bank_account"|"invalid_bank_account"|"invalid_routing"|"disputed"|"payment_stopped"|"owner_deceased"|"frozen_bank_account"|"risk_review"|"fraudulent"|"duplicate_entry"|"invalid_paykey"|"payment_blocked"|"amount_too_large"|"too_many_attempts"|"internal_system_error"|"user_request"|"ok"|"other_network_return"|"payout_refused"|"cancel_request"|"failed_verification"|"require_review"|"blocked_by_system"|"watchtower_review"|"validating"|"auto_hold") - **source** (string (watchtower|bank_decline|customer_dispute|user_action|system)) (required) ("watchtower"|"bank_decline"|"customer_dispute"|"user_action"|"system") - **code** (string): The status code if applicable. - **changed_at** (string (date-time)) (required): The time the status change occurred. - **expires_at** (string (date-time)): Expiration date and time of the paykey, if applicable. - **created_at** (string (date-time)) (required): Timestamp of when the paykey was created. - **updated_at** (string (date-time)) (required): Timestamp of the most recent update to the paykey. - **paykey** (string) (required): The tokenized paykey value. This value is used to create payments and should be stored securely. - **bank_data** (object) - **routing_number** (string) (required): The routing number of the bank account. (example: "021000021") - **account_number** (string) (required): Bank account number. This value is masked by default for security reasons. Use the /unmask endpoint to access the unmasked value. (example: "****1234") - **account_type** (string (checking|savings)) (required) ("checking"|"savings") - **metadata** (object): Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the paykey in a structured format. - **config** (object) (required) - **sandbox_outcome** (string (standard|active|rejected|review)) ("standard"|"active"|"rejected"|"review") - **processing_method** (string (inline|background|skip)) ("inline"|"background"|"skip") - **balance** (object) - **account_balance** (integer (int32)): Account Balance when last retrieved - **updated_at** (string (date-time)): Last time account balance was updated. - **status** (string (pending|completed|failed)) (required) ("pending"|"completed"|"failed") - **external_id** (string): Unique identifier for the paykey in your database, used for cross-referencing between Straddle and your systems. - **unblock_eligible** (boolean): Indicates whether this paykey is eligible for client-initiated unblocking. Only present for blocked paykeys. True when blocked due to R29 returns and not previously unblocked, false otherwise. Null when paykey is not blocked. - **verification_details** (object) - **id** (string (uuid)) (required): Unique identifier for the verification details. - **decision** (string (accept|reject|review)) (required) ("accept"|"reject"|"review") - **messages** (object) (required): Dictionary of all messages from the paykey verification process. - **breakdown** (object) (required) - **name_match** (object) - **names_on_account** (array (string)) - **matched_name** (string) - **customer_name** (string) - **correlation_score** (number (double)) - **decision** (string (accept|reject|review)) (required) ("accept"|"reject"|"review") - **reason** (string) - **codes** (array (string)) (required) - **account_validation** (object) - **decision** (string (accept|reject|review)) (required) ("accept"|"reject"|"review") - **reason** (string) - **codes** (array (string)) (required) - **created_at** (string (date-time)) (required): Timestamp of when the verification was initiated. - **updated_at** (string (date-time)) (required): Timestamp of the most recent update to the verification details. **PaykeyReviewV1ItemResponse** **PaykeyReviewV1ItemResponse** #### 400 - Bad Request **ErrorResponse** - **meta** (object) (required): Metadata about the API request, including an identifier and timestamp. - **api_request_id** (string (uuid)) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string (date-time)) (required): Timestamp for this API request, useful for troubleshooting. - **response_type** (string (object|array|error|none)) (required): Indicates the structure of the returned content. - "object" means the `data` field contains a single JSON object. - "array" means the `data` field contains an array of objects. - "error" means the `data` field contains an error object with details of the issue. - "none" means no data is returned. ("object"|"array"|"error"|"none") - **error** (object) (required) - **status** (integer (int32)) (required): HTTP status code for the error. - **type** (string) (required): Predefined general type of error (e.g. '/field_validation') - **title** (string) (required): Generic message for this type of issue. - **detail** (string): Specific message regarding this exact request. - **items** (array (ErrorItem)): Array of error objects with more specific details. Array items: - **reference** (string): Identifier for the error (e.g., field name, error code). - **detail** (string) (required): Detailed description of the specific error. **ErrorResponse** **ErrorResponse** #### 401 - Unauthorized **ErrorResponse** - **meta** (object) (required): Metadata about the API request, including an identifier and timestamp. - **api_request_id** (string (uuid)) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string (date-time)) (required): Timestamp for this API request, useful for troubleshooting. - **response_type** (string (object|array|error|none)) (required): Indicates the structure of the returned content. - "object" means the `data` field contains a single JSON object. - "array" means the `data` field contains an array of objects. - "error" means the `data` field contains an error object with details of the issue. - "none" means no data is returned. ("object"|"array"|"error"|"none") - **error** (object) (required) - **status** (integer (int32)) (required): HTTP status code for the error. - **type** (string) (required): Predefined general type of error (e.g. '/field_validation') - **title** (string) (required): Generic message for this type of issue. - **detail** (string): Specific message regarding this exact request. - **items** (array (ErrorItem)): Array of error objects with more specific details. Array items: - **reference** (string): Identifier for the error (e.g., field name, error code). - **detail** (string) (required): Detailed description of the specific error. **ErrorResponse** **ErrorResponse** #### 403 - Forbidden **ErrorResponse** - **meta** (object) (required): Metadata about the API request, including an identifier and timestamp. - **api_request_id** (string (uuid)) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string (date-time)) (required): Timestamp for this API request, useful for troubleshooting. - **response_type** (string (object|array|error|none)) (required): Indicates the structure of the returned content. - "object" means the `data` field contains a single JSON object. - "array" means the `data` field contains an array of objects. - "error" means the `data` field contains an error object with details of the issue. - "none" means no data is returned. ("object"|"array"|"error"|"none") - **error** (object) (required) - **status** (integer (int32)) (required): HTTP status code for the error. - **type** (string) (required): Predefined general type of error (e.g. '/field_validation') - **title** (string) (required): Generic message for this type of issue. - **detail** (string): Specific message regarding this exact request. - **items** (array (ErrorItem)): Array of error objects with more specific details. Array items: - **reference** (string): Identifier for the error (e.g., field name, error code). - **detail** (string) (required): Detailed description of the specific error. **ErrorResponse** **ErrorResponse** #### 404 - Not Found **ErrorResponse** - **meta** (object) (required): Metadata about the API request, including an identifier and timestamp. - **api_request_id** (string (uuid)) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string (date-time)) (required): Timestamp for this API request, useful for troubleshooting. - **response_type** (string (object|array|error|none)) (required): Indicates the structure of the returned content. - "object" means the `data` field contains a single JSON object. - "array" means the `data` field contains an array of objects. - "error" means the `data` field contains an error object with details of the issue. - "none" means no data is returned. ("object"|"array"|"error"|"none") - **error** (object) (required) - **status** (integer (int32)) (required): HTTP status code for the error. - **type** (string) (required): Predefined general type of error (e.g. '/field_validation') - **title** (string) (required): Generic message for this type of issue. - **detail** (string): Specific message regarding this exact request. - **items** (array (ErrorItem)): Array of error objects with more specific details. Array items: - **reference** (string): Identifier for the error (e.g., field name, error code). - **detail** (string) (required): Detailed description of the specific error. **ErrorResponse** **ErrorResponse** #### 422 - Validation Failed **ErrorResponse** - **meta** (object) (required): Metadata about the API request, including an identifier and timestamp. - **api_request_id** (string (uuid)) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string (date-time)) (required): Timestamp for this API request, useful for troubleshooting. - **response_type** (string (object|array|error|none)) (required): Indicates the structure of the returned content. - "object" means the `data` field contains a single JSON object. - "array" means the `data` field contains an array of objects. - "error" means the `data` field contains an error object with details of the issue. - "none" means no data is returned. ("object"|"array"|"error"|"none") - **error** (object) (required) - **status** (integer (int32)) (required): HTTP status code for the error. - **type** (string) (required): Predefined general type of error (e.g. '/field_validation') - **title** (string) (required): Generic message for this type of issue. - **detail** (string): Specific message regarding this exact request. - **items** (array (ErrorItem)): Array of error objects with more specific details. Array items: - **reference** (string): Identifier for the error (e.g., field name, error code). - **detail** (string) (required): Detailed description of the specific error. **ErrorResponse** **ErrorResponse** #### 500 - Server Error **ErrorResponse** - **meta** (object) (required): Metadata about the API request, including an identifier and timestamp. - **api_request_id** (string (uuid)) (required): Unique identifier for this API request, useful for troubleshooting. - **api_request_timestamp** (string (date-time)) (required): Timestamp for this API request, useful for troubleshooting. - **response_type** (string (object|array|error|none)) (required): Indicates the structure of the returned content. - "object" means the `data` field contains a single JSON object. - "array" means the `data` field contains an array of objects. - "error" means the `data` field contains an error object with details of the issue. - "none" means no data is returned. ("object"|"array"|"error"|"none") - **error** (object) (required) - **status** (integer (int32)) (required): HTTP status code for the error. - **type** (string) (required): Predefined general type of error (e.g. '/field_validation') - **title** (string) (required): Generic message for this type of issue. - **detail** (string): Specific message regarding this exact request. - **items** (array (ErrorItem)): Array of error objects with more specific details. Array items: - **reference** (string): Identifier for the error (e.g., field name, error code). - **detail** (string) (required): Detailed description of the specific error. **ErrorResponse** **ErrorResponse** ### Example Usage ```bash curl -X GET "https://{environment}.straddle.com/v1/paykeys/{id}/review" ``` ``` -------------------------------- ### Schema: SandboxPaymentOutcomeV1 Source: https://app.stainless.com/api/spec/documented/straddle/openapi.documented.yml Payment will simulate processing if not Standard. ```markdown ## Schema: SandboxPaymentOutcomeV1 Payment will simulate processing if not Standard. **Type:** string ```