{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"15c10c4e-04a3-49ef-8160-2fd6da2d4d86","name":"Platform API Documentation 1","description":"<img src=\"https://img.shields.io/badge/version-1.8-lightgrey.svg\" alt=\"Platform API Version\">\n\n# 1\\. Overview\n\nThis RESTful API empowers customers and partners to build custom applications that interact with Snap Finance.\n\nThe reference documentation does not cover all scenarios or roles. Permission and client data will differ based on modules and integrations that interact with Snap Finance. Mock examples complete with requests, responses, and parameters are provided for general understanding. For advance assistance contact [devsupport@snapfinance.com](https://mailto:devsupport@snapfinance.com)\n\n---\n\n# 2\\. Authentication\n\nSend a secure request to get an authorization token.\n\nEvery REST API endpoint you access requires you to supply an access token in the header of your request to verify that you are an authorized user.\n\nAuthorization involves the following three steps:\n\n- Generate a client secret based on your client ID.\n- Use the secret to get an access token.\n- Include the access token in all API requests.\n    \n\n---\n\n# 3\\. Product Experiences\n\nCustomer personal identifying information (PII) information, bank information, income information, and purchase information are required for Snap Finance to make an approval decision on a lease application. Snap provides two product experiences depending on how the merchant gathers this information from the customer. After approval, customers must accept the Snap lease agreement. These agreements can be generated only after approval of the application.\n\n**(1) Snap Pre-qualification Application**\n\nPre-qualification is an estimate of the amount a customer may be approved for. Customers can pre-qualify for a Snap Finance lease by providing only their PII. To formally apply for a lease and potentially be approved, they must also provide their bank and income information.\n\nThe customer must be approved for a Snap Finance lease before the lease agreement will be generated and they can sign. At first the application will be created with the Create Application API call and the application will be in PREQUALIFIED status. This application then can be updated and moved to APPROVED status by using an updated application API call and providing bank and income information.\n\nThere is a possibility that customers may be denied after they provide their bank and income information.\n\n**(2) Snap Full Application**\n\nIf the merchant collects all the information before sending the application for decisioning, a full and final approval can be obtained just by calling the Create Application API.\n\n# 4\\. Response Messages\n\nSnap uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success. Codes in the 4xx range indicate an error with the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Snap's servers.\n\n## 4.1 HTTP Response Status Codes\n\n| Code | Description |\n| --- | --- |\n| **200 - OK** | Everything worked as expected |\n| **400 - Bad Request** | The request was unacceptable, often due to missing a required parameter or to an invalid parameter. |\n| **401 - Unauthorized** | Invalid token provided. |\n| **402 - Request Failed** | The parameters were valid, but the request failed. |\n| **403 - Forbidden** | The provided token does not have permissions to perform the request. |\n| **404 - Not Found** | The requested resource does not exist. |\n| **500, 504 - Server Errors** | Something went wrong on Snap's end. |\n\n## 4.2 Error Response Types\n\n| Code | Description |\n| --- | --- |\n| **api_error** | Errors that occur in our servers (rare occurrences). |\n| **authentication_error** | Failure during the authentication process. |\n| **authorization_error** | Authorization errors occur when a token is reused on a request that does not match the first request API endpoint and parameters. |\n| **invalid_request_error** | Invalid request errors arise when your request has invalid parameters. |\n| **validation_error** | Errors triggered by our client-side libraries when failing to validate fields (e.g., when a card number or expiration date is invalid or incomplete). |\n\n# 5\\. Idempotency Request\n\nFor an operation to be idempotent, clients can make the same call many times while producing the same result. In other words, making multiple identical requests has the same effect as making a single request.\n\nTo perform an idempotent request, provide an additional Idempotency-Key: header to the request. An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request.\n\nThe way to create the keys is up to you, however we suggest that they be random keys that do not repeat themselves. For this it is recommended to use a Version 4 UUID that is a universally unique identifier that is generated using random numbers.\n\nThe idempotency used by Snap works by saving the resulting status code and the body of the first request to create an application for any given idempotency key, regardless of whether it was successful or not. Subsequent requests using the same key in the header will get the response that was generated in the first instance.\n\nUsing the idempotency key is possible to retry requests without accidentally performing the same operation twice and duplicate the applications. You can retry the request with the same idempotency key to ensure that no more than one application is created.\n\nKeys expire 24 hours after they are created, after that period of time they are removed from the system, therefore, if a request is sent with an expired key, it will be processed as a new request.\n\nOnly POST requests to create applications accept idempotency. Sending idempotency keys in other requests will have no effect.\n\n# 6\\. Response Objects\n\n## 6.1 Success Object\n\n```\n{\n  \"success\": true,\n  \"data\": {...},\n  \"status\": 200\n}\n\n ```\n\n> The `data` property is a JSON object which has the response from the endpoint. \n  \n\n## 6.2 Failure Object\n\n```\n{\n  \"success\": false,\n  \"error\": [\n      {...}\n  ],\n  \"status\": xxx\n}\n\n ```\n\n> The `error` property is a JSON array with all errors. See details in section **4.3 Error Object**. \n  \n\n## 6.3 Error Object\n\n```\n{\n  \"type\":\"\",\n  \"code\":\"\",\n  \"message\":\"\"\n}\n\n ```\n\n> **type** _String_ \n  \n> **code** _String_ \n  \n> **message** _String_ \n  \n\n# 7\\. Errors\n\nList of error codes and messages used by the APIs:\n\n- > **account_activity** - _(validation_error)_ \n      \n    \n\n- > **application_canceled** - _(validation_error)_ \n      \n    \n\n- > **application_denied** - _(validation_error)_ \n      \n    \n\n- > **agreement_not_found** - _(api_error)_ \n      \n    \n\n- > **customer_not_found** - _(validation_error)_ \n      \n    \n\n- > **routing_number_not_found** - _(validation_error)_ \n      \n    \n\n- > **application_not_found** - _(invalid_request_error)_ \n      \n    \n\n- > **city_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **city_invalid** - _(validation_error)_ \n      \n    \n\n- > **drivers_license_state_invalid** - _(validation_error)_ \n      \n    \n\n- > **email_address_invalid** - _(validation_error)_ \n      \n    \n\n- > **language_invalid** - _(validation_error)_ \n      \n    \n\n- > **merchant_not_found** - _(validation_error)_ \n      \n    \n\n- > **order_id_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **invalid_state** - _(validation_error)_ \n      \n    \n\n- > **Ssn_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **invalid_ssn** - _(validation_error)_ \n      \n    \n\n- > **total_amt_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **pay_day_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **phone_number_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **phone_number_invalid** - _(validation_error)_ \n      \n    \n\n- > **rent_or_own_missing** - _(validation_error)_ \n      \n    \n\n- > **state_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **unauthorized_call** - _(authorization_error)_ \n      \n    \n\n- > **years_at_residence_invalid** - _(validation_error)_ \n      \n    \n\n- > **zip_code_invalid** - _(validation_error)_ \n      \n    \n\n- > **application_status_rule** - _(validation_error)_ \n      \n    \n\n- > **bank_name_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **bank_city_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **bank_city_invalid** - _(validation_error)_ \n      \n    \n\n- > **bank_state_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **bank_direct_deposit_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **customer_income_type_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **employer_name_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **position_held_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **startdate_invalid** - _(validation_error)_ \n      \n    \n\n- > **bank_routing_number_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **bank_routing_number_invalid** - _(validation_error)_ \n      \n    \n\n- > **checking_account_number_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **checking_account_number_minimum_characters_invalid** - _(validation_error)_ \n      \n    \n\n- > **Date_of_birth_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **Date_of_birth_incorrect_invalid** - _(validation_error)_ \n      \n    \n\n- > **driver_license_missing** - _(validation_error)_ \n      \n    \n\n- > **driver_license_special_characters_invalid** - _(validation_error)_ \n      \n    \n\n- > **email_address_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **email_address_format_invalid** - _(validation_error)_ \n      \n    \n\n- > **first_name_minimum_characters_invalid** - _(validation_error)_ \n      \n    \n\n- > **last_name_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **last_name_minimum_characters_invalid** - _(validation_error)_ \n      \n    \n\n- > **mobile_phone_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **mobile_phone_minimum_characters_invalid** - _(validation_error)_ \n      \n    \n\n- > **street_address_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **street_address_minimum_characters_invalid** - _(validation_error)_ \n      \n    \n\n- > **verification_code_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **verification_code_invalid** - _(validation_error)_ \n      \n    \n\n- > **zip_code_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **address_not_found** - _(invalid_request_error)_ \n      \n    \n\n- > **address_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **ssn_format_invalid** - _(validation_error)_ \n      \n    \n\n- > **email_invalid** - _(invalid_request_error)_ \n      \n    \n\n- > **email_not_validated** - _(validation_error)_ \n      \n    \n\n- > **nextPaymentDate_invalid** - _(validation_error)_ \n      \n    \n\n- > **lastPaymentDate_invalid** - _(validation_error)_ \n      \n    \n\n- > **payDateInput_invalid** - _(validation_error)_ \n      \n    \n\n- > **payDateMonthly_invalid** - _(validation_error)_ \n      \n    \n\n- > **payDate_SM_invalid** - _(validation_error)_ \n      \n    \n\n- > **secondPayDateAfter_invalid** - _(validation_error)_ \n      \n    \n\n- > **secondPayDate_invalid** - _(validation_error)_ \n      \n    \n\n- > **secondPayDateInput_invalid** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **customerInformation_customerIdType_invalid** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_customerIdType_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **customerInformation_customerId_invalid** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_customerId_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **customerInformation_mobilePhoneCountry_invalid** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_mobilePhoneCountry_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **customerInformation_suffix_invalid** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_suffix_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **customerInformation_billingAddress_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **customerInformation_billingAddress_streetAddress_invalid** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_billingAddress_state_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **customerInformation_billingAddress_country_invalid** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_billingAddress_country_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **customerInformation_billingAddress_postalCode_invalid** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_billingAddress_postalCode_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **customerInformation_rentOwn_invalid** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_timeAddressYears_missing** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_timeAddressMonths_invalid** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_timeAddressMonths_missing** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_phoneOptIn_invalid** - _(validation_error)_ \n      \n    \n\n- > **customerInformation_phoneOptIn_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **customerInformation_driversLicenseState_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **cartInformation_currencyCode_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_currencyCode_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **cartInformation_totalAmount_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_totalAmount_minimum_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_total_amount_calculation_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_taxAmount_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_taxAmount_minimum_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_discountAmount_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_discountAmount_minimum_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_shippingAmount_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_shippingAmount_minimum_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_orderId_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_items_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **cartInformation_items_price_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **cartInformation_items_price_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_items_price_minimum_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_items_itemId_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **cartInformation_items_itemId_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_items_description_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **cartInformation_items_description_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_items_sku_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **cartInformation_items_sku_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_items_quantity_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **cartInformation_items_quantity_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_items_leasable_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **cartInformation_items_leasable_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_items_leasable_not_accepted** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_shippingAddress_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **cartInformation_shippingAddress_country_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **cartInformation_shippingAddress_country_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_shippingAddress_postalCode_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **cartInformation_shippingAddress_postalCode_invalid** - _(validation_error)_ \n      \n    \n\n- > **cartInformation_shippingAddress_streetAddress_invalid** - _(validation_error)_ \n      \n    \n\n- > **incomeInformation_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **incomeInformation_allowed_items_exceeded** - _(invalid_request_error)_ \n      \n    \n\n- > **incomeInformation_employerName_invalid** - _(validation_error)_ \n      \n    \n\n- > **incomeInformation_positionHeld_invalid** - _(validation_error)_ \n      \n    \n\n- > **incomeInformation_frequency_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **incomeInformation_frequency_invalid** - _(validation_error)_ \n      \n    \n\n- > **incomeInformation_incomeAmount_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **incomeInformation_incomeAmount_invalid** - _(validation_error)_ \n      \n    \n\n- > **incomeInformation_incomeAmount_minimum_invalid** - _(validation_error)_ \n      \n    \n\n- > **incomeInformation_phoneCountryCode_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **incomeInformation_phoneCountryCode_invalid** - _(validation_error)_ \n      \n    \n\n- > **incomeInformation_positionHeld_invalid** - _(validation_error)_ \n      \n    \n\n- > **incomeInformation_type_invalid** - _(validation_error)_ \n      \n    \n\n- > **incomeInformation_lastPayDate_invalid** - _(validation_error)_ \n      \n    \n\n- > **incomeInformation_nextPayDate_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **incomeInformation_nextPayDate_invalid** - _(validation_error)_ \n      \n    \n\n- > **incomeInformation_not_provided** - _(invalid_request_error)_ \n      \n    \n\n- > **bankInformation_bankName_invalid** - _(validation_error)_ \n      \n    \n\n- > **bankInformation_bankState_invalid** - _(validation_error)_ \n      \n    \n\n- > **bankInformation_directDeposit_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **bankInformation_directDeposit_invalid** - _(validation_error)_ \n      \n    \n\n- > **termsConditions_acceptance_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **termsConditions_acceptance_invalid** - _(validation_error)_ \n      \n    \n\n- > **internal_server_error** - _(internal_server_error)_ \n      \n    \n\n- > **request_body_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **invalid_body_request** - _(validation_error)_ \n      \n    \n\n- > **invalid_patch_application_status** - _(invalid_request_error)_ \n      \n    \n\n- > **application_invalid_status** - _(invalid_request_error)_ \n      \n    \n\n- > **bankInformation_invalid** - _(invalid_request_error)_ \n      \n    \n\n- > **recipient_invalid** - _(validation_error)_ \n      \n    \n\n- > **recipient_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **channel_invalid** - _(validation_error)_ \n      \n    \n\n- > **channel_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **verificationResourceId_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **verificationResourceId_invalid** - _(validation_error)_ \n      \n    \n\n- > **invalid_payment_dates** - _(validation_error)_ \n      \n    \n\n- > **shippingDate_invalid** - _(validation_error)_ \n      \n    \n\n- > **deliveryDate_invalid** - _(validation_error)_ \n      \n    \n\n- > **deliveryDate_already_set** - _(validation_error)_ \n      \n    \n\n- > **deliveryDate_incorrect** - _(validation_error)_ \n      \n    \n\n- > **amount_invalid** - _(validation_error)_ \n      \n    \n\n- > **amount_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **itemId_invalid** - _(validation_error)_ \n      \n    \n\n- > **itemId_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **quantity_invalid** - _(validation_error)_ \n      \n    \n\n- > **quantity_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **frequency_invalid** - _(validation_error)_ \n      \n    \n\n- > **signedDate_invalid** - _(validation_error)_ \n      \n    \n\n- > **signedDate_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **signedMethod_invalid** - _(validation_error)_ \n      \n    \n\n- > **signedMethod_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **deviceIP_invalid** - _(validation_error)_ \n      \n    \n\n- > **agreement_information_missing** - _(validation_error)_ \n      \n    \n\n- > **payment_plan_information_missing** - _(validation_error)_ \n      \n    \n\n- > **refund_product_price_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **refund_product_price_invalid** - _(validation_error)_ \n      \n    \n\n- > **refund_product_price_minimum_invalid** - _(validation_error)_ \n      \n    \n\n- > **refunds_items_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **refund_product_quantity_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **refund_product_quantity_invalid** - _(validation_error)_ \n      \n    \n\n- > **refund_product_itemId_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **refund_product_itemId_invalid** - _(validation_error)_ \n      \n    \n\n- > **lookup_cid_type_invalid** - _(validation_error)_ \n      \n    \n\n- > **lookup_applications_not_found** - _(validation_error)_ \n      \n    \n\n- > **lookup_cid_invalid** - _(validation_error)_ \n      \n    \n\n- > **lookup_body_invalid** - _(validation_error)_ \n      \n    \n\n- > **supplementalDataInformation_invalid** - _(validation_error)_ \n      \n    \n\n- > **supplementalDataInformation_missing** - _(invalid_request_error)_ \n      \n    \n\n- > **invalid_patch_app_origin_channel** - _(invalid_request_error)_ \n      \n    \n\n- > **request_body_invalid** - _(invalid_request_error)_ \n      \n    \n\n- > **verificationCode_customerName_missing** - _(validation_error)_ \n      \n    \n\n- > **preapproval_checkoutId_missing** - _(validation_error)_ \n      \n    \n\n- > **preapproval_applicationId_missing** - _(validation_error)_ \n      \n    \n\n- > **preapproval_checkoutId_notFound** - _(validation_error)_ \n      \n    \n\n- > **invalid_experience_error** - _(invalid_request_error)_ \n      \n    \n\n- > **reporting_api_offset_invalid** - _(reporting_api_offset_invalid)_ \n      \n    \n\n- > **reporting_api_offset_missing** - _(reporting_api_offset_missing)_ \n      \n    \n\n- > **reporting_api_limit_invalid** - _(reporting_api_limit_invalid)_ \n      \n    \n\n- > **reporting_api_limit_missing** - _(reporting_api_limit_missing)_ \n      \n    \n\n- > **reporting_api_startDatetime_invalid** - _(reporting_api_startDatetime_invalid)_ \n      \n    \n\n- > **reporting_api_startDatetime_missing** - _(reporting_api_startDatetime_missing)_ \n      \n    \n\n- > **reporting_api_endDatetime_invalid** - _(reporting_api_endDatetime_invalid)_ \n      \n    \n\n- > **reporting_api_endDatetime_missing** - _(reporting_api_endDatetime_missing)_ \n      \n    \n\n- > **reporting_api_query_string_params_missing** - _(reporting_api_query_string_params_missing)_ \n      \n    \n\n- > **reporting_api_query_string_params_invalid** - _(reporting_api_query_string_params_invalid)_ \n      \n    \n\n- > **reporting_api_keyword_invalid** - _(reporting_api_keyword_invalid)_ \n      \n    \n\n- > **reporting_api_applicationId_invalid** - _(reporting_api_applicationId_invalid)_ \n      \n    \n\n- > **reporting_api_status_invalid** - _(reporting_api_status_invalid)_ \n      \n    \n\n- > **reporting_api_amount_invalid** - _(reporting_api_amount_invalid)_ \n      \n    \n\n- > **reporting_api_mobilePhone_invalid** - _(reporting_api_mobilePhone_invalid)_ \n      \n    \n\n- > **reporting_api_firstName_invalid** - _(reporting_api_firstName_invalid)_ \n      \n    \n\n- > **reporting_api_lastName_invalid** - _(reporting_api_lastName_invalid)_ \n      \n    \n\n- > **cardInfo_invalid** - _(invalid_request_error)_ \n      \n    \n\n- > **cardInfo_cardNumber_invalid** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_expirationMonth_invalid** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_expirationYear_invalid** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_expired** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_cvvCode_invalid** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_cardType_invalid** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_billingName_invalid** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_streetAddress_invalid** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_city_invalid** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_state_invalid** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_state_non_existent** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_zipcode_invalid** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_billingAddress_postalCode_invalid** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_phoneNumber_invalid** - _(validation_error)_ \n      \n    \n\n- > **cardInfo_email_invalid** - _(validation_error)_ \n      \n    \n\n- > **paymentMethodInfo_invalid** - _(invalid_request_error)_ \n      \n    \n\n- > **paymentMethodInfo_paymentType_invalid** - _(validation_error)_ \n      \n    \n\n- > **paymethod_missing_card** - _(validation_error)_ \n      \n    \n\n# 8\\. Testing Data\n\nUse the following combinations to create applications as desired:\n\n| CustomerIdType | SSN | DOB | Result |\n| --- | --- | --- | --- |\n| SSN | Any 9 | 07-07-1977 | Application Approved |\n| SSN | Any 9 | 06-06-1966 | Application Denied |\n| SSN4 | Any 4 | 07-07-1977 | Application Approved |\n| SSN4 | Any 4 | 06-06-1966 | Application Denied |\n\nTo simulate the three bank account attempts scenario use a bank account following the next mask, XXXXXXXXX0; same value for the first 9 digits and a zero to complete 10 digits. Example:\n\n- 9999999990\n- 8888888880\n- 7777777770\n- 6666666660\n    \n\nUsing those numbers, the first two attempts will return an error:\n\n- > **bankInformation_invalid** - _(invalid_request_error)_ \n      \n    \n\nThe third attempt will return DENIED application status.\n\n**Important:** Change bank account number between calls. Using the same value will not increase the attempts count.\n\n| Test case scenario | SSN | DOB | First Name | Last Name | Address | Bank Routing | Bank Account number | Expected results | Comments |\n| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |\n| Prequal Approval | Any 9 | 7-Jul-77 | Any | Any | Any | Routing - 122000247 | Any | Application Approved |  |\n| Final Approval | Any 9 | 7-Jul-77 | Any | Any | Any | Routing - 122000247 | Any | Application Approved |  |\n| Prequal Denial | Any 9 | 6-Jun-66 | Any | Any | Any | Routing - 122000247 | Any | Application Denied |  |\n| Final Denial | Any 9 | 7-Jul-77 | Any | Any | Any | Valid routing number - 122000247 | 9999999990 | Application Denied | Please check  <br>[https://platform.api-spec.snapfinance.com/#8-testing-data](https://platform.api-spec.snapfinance.com/#8-testing-data)  <br>for additional details to simulate this scenario |\n| Pending - Credit Freeze(at the Prequal step) | Any 9 | 1/1/01 | Any | Wilson | Any | Valid routing number - 122000247 | Any | Application Pending due to Credit Freeze | Use last name \"Wilson\" with the request. Application should go into Pending. |\n\n| Test case scenario | Expected results | Comments |\n| --- | --- | --- |\n| STBS (Snap collects the taxes) | CT, IL, PA, VA, TX, WI, MN, and NJ. \\*Include STBS disclosures.\\*Taxes will be excluded from the total cart amount. | Collect the Taes and send it within the Taxes field of the API.  <br>  <br>Use the following address for testing : 822 Main St Wolfforth, Texas(TX), 79382 |\n| Opt-In and T&C (Terms and Conditions) |  | Test “TRUE” and “FALSE” values. |\n\n| Test case scenario | Expected results | Comments |\n| --- | --- | --- |\n| T&C Hyperlinks |  | Hyperlinks should redirect to right documents. Privacy Policy:PDF:  <br>[https://snap-app-docs-public.s3-us-west-2.amazonaws.com/Snap_Privacy_Policy.pdf](https://snap-app-docs-public.s3-us-west-2.amazonaws.com/Snap_Privacy_Policy.pdf)  <br>Website:  <br>[https://snapfinance.com/legal/privacy](https://snapfinance.com/legal/privacy)  <br>Terms and Conditions:PDF:  <br>[https://snap-app-docs-public.s3-us-west-2.amazonaws.com/Snap_Terms_and_Conditions.pdf](https://snap-app-docs-public.s3-us-west-2.amazonaws.com/Snap_Terms_and_Conditions.pdf)  <br>E-Consent disclosure (Clause inside of the T&Cs):PDF:  <br>[https://snap-app-docs-public.s3-us-west-2.amazonaws.com/Snap_Terms_and_Conditions.pdf](https://snap-app-docs-public.s3-us-west-2.amazonaws.com/Snap_Terms_and_Conditions.pdf) |\n| CANCEL | Successful Void |  |\n| CAPTURE | Successful Capture |  |\n| REFUND | Successful Refund |  |\n| MIN AMOUNT 150 | Error handling |  |\n| CART AMOUNT IS LOWER THAN APPROVAL AMOUNT | Error handling |  |\n| Invalid Data Decline on Paycheck Details | Error handling |  |\n| Invalid Data Decline on Bank Account Details | Error handling |  |\n| OTP Retries |  |  |\n| OTP Failure | Error handling |  |\n| Non-leasable Item | Error handling |  |\n| Non-leasable State | Error handling | Use Wisconsin, Minnesota, or New Jersey |\n\n# **9\\. Support**\n\nContact [devsupport@snapfinance.com](https://mailto:devsupport@snapfinance.com) for assistance.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5518752","team":252058,"collectionId":"15c10c4e-04a3-49ef-8160-2fd6da2d4d86","publishedId":"2sB2xFdn4H","public":true,"publicUrl":"https://platform.api-spec.snapfinance.com","privateUrl":"https://go.postman.co/documentation/5518752-15c10c4e-04a3-49ef-8160-2fd6da2d4d86","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2025-07-02T20:53:35.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Platform Sandbox Generic","id":"a66c6628-bf5b-4d15-aec1-73a3c4792281","owner":"5518752","values":[{"key":"baseUrl","value":"https://api-sandbox.snapfinance.com","enabled":true},{"key":"applicationId","value":"{{applicationId}}","enabled":true},{"key":"authClientId","value":"Add your client id here","enabled":true},{"key":"authClientSecret","value":"Add your client secret here","enabled":true},{"key":"authClientAudience","value":"https://api-release.snapfinance.com/platform/v1","enabled":true},{"key":"authHostUrl","value":"https://auth-sandbox.snapfinance.com","enabled":true},{"key":"bearerToken","value":"pORU5GTWtNeE1UQkJPVE5DUl....JiWYvnmRQSSCozUr6Xt7RXRK","enabled":true},{"key":"verificationResourceId","value":"6f9df6d...6526ddcdf","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1e8791e955a34e9630884d55d4d93b78c5058bc3f37e312ac88e9153f9ba1e39","favicon":"https://res.cloudinary.com/postman/image/upload/v1548105665/team/czptcehcbl38beamjo6z.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Platform Sandbox Generic","value":"5518752-a66c6628-bf5b-4d15-aec1-73a3c4792281"}],"canonicalUrl":"https://platform.api-spec.snapfinance.com/view/metadata/2sB2xFdn4H"}