{"paths":{"/getTransHistory":{"post":{"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"start_date":{"type":"string","format":"date-time","description":"The start date for the transaction range"},"end_date":{"type":"string","format":"date-time","description":"The end date for the transaction range"},"number_of_pages":{"type":"integer","format":"int32","description":"The total number of pages available in the paginated response"},"page":{"type":"integer","format":"int32","description":"The current page being retunred in the paginated response"},"total_record_count":{"type":"integer","format":"int32","description":"Number of records in the accounts list display"},"transaction_count":{"type":"integer","format":"int32","description":"The number of transactions listed in the response"},"transactions":{"type":"array","description":"List of transactions","items":{"type":"object","properties":{"pmt_ref_no":{"type":"string","nullable":true,"description":"Payment reference number."},"act_id":{"type":"string","nullable":true,"description":"Transaction activity identifier used in the SoFi Tech Solutions system"},"act_type":{"type":"string","nullable":true,"description":"Identifier for the transaction activity type. See the Activity Type enumeration."},"post_ts":{"type":"string","format":"date-time","nullable":true,"description":"System timestamp when the transaction posted to the customer account, in our system time"},"amt":{"type":"string","nullable":true,"description":"The transaction amount in the currency of the account. A negative amount debits funds from the customer account."},"details":{"type":"string","nullable":true,"description":"Description provided by the merchant about the transaction (DE043)"},"description":{"type":"string","nullable":true,"description":"Description of the activity type specified in the `act_type` field. See the Activity Type enumeration."},"source_id":{"type":"string","nullable":true,"description":"System-generated identifier that maps to the original transaction, such as `auth_id`, `pmt_id`, or `adj_id`"},"bal_id":{"type":"string","nullable":true,"description":"Balance ID, a system-generated identifier for the account on which the transaction occurs. Maps to `galileo_account_number`."},"prod_id":{"type":"string","nullable":true,"description":"Identifier for the product associated with the account"},"auth_ts":{"type":"string","format":"date-time","nullable":true,"description":"System timestamp when the transaction was authorized, in our system time"},"trans_code":{"type":"string","nullable":true,"description":"Reference your program's activity and transaction types for possible values."},"ach_transaction_id":{"type":"string","nullable":true,"description":"Identifier for the ACH transaction, if applicable"},"external_trans_id":{"type":"string","nullable":true,"description":"Optional identifier for a transaction that you supply. External to the system."},"original_auth_id":{"type":"string","nullable":true,"description":"The `auth_id` of the previous transaction in the sequence, if any. Maps to `prior_id`."},"network_code":{"type":"string","nullable":true,"description":"A system-generated code to identify the subnetwork over which the transaction took place. Maps to `network_id`."},"local_amt":{"type":"string","nullable":true,"description":"Amount, in cents, of the authorization request, in the currency at the point of sale. 12-digit number including leading zeros. This amount does not include upcharges or program fees. (DE004)"},"local_curr_code":{"type":"string","nullable":true,"description":"Currency code for `local_amt` (DE049)"},"settle_amt":{"type":"string","nullable":true,"description":"The transaction amount in the settlement currency (DE005)"},"settle_curr_code":{"type":"string","nullable":true,"description":"Currency code for `settle_amt` (DE050)"},"billing_amt":{"type":"string","nullable":true,"description":"The transaction amount in the currency of the account (DE006) "},"billing_curr_code":{"type":"string","nullable":true,"description":"Currency code for `billing_amt` (DE051)"},"mcc":{"type":"string","nullable":true,"description":"Category code for the merchant that initiated the transaction (DE018)"},"merchant_id":{"type":"string","nullable":true,"description":"Network-assigned identifier for a merchant (DE042)"},"formatted_merchant_desc":{"type":"string","nullable":true,"description":"The same information as in the `details` field, with formatting"},"terminal_id":{"type":"string","nullable":true,"description":"Identifier for the card reader at the point of sale (DE041)"},"card_id":{"type":"string","nullable":true,"description":"A system-generated identifier for a card, which can be used instead of the PAN. Maps to `cad`."},"credit_ind":{"type":"string","nullable":true,"description":"Indicates whether a PIN was input at the point of sale. `Y` = No PIN was input. `N` = A PIN was input. `None` = Not a card transaction."},"iac_tax":{"type":"number","format":"float","nullable":true,"description":"Impuesto al Consumo. Colombian consumption tax. Required for the Mastercard Interchange Intracountry Calculation Program."},"iva_tax":{"type":"number","format":"float","nullable":true,"description":"Impuesto al Valor Agregado. Colombian value-added tax. Required for the Mastercard Interchange Intracountry Calculation Program."},"funding_account_prn":{"type":"string","nullable":true,"description":"The <> of the <> funding account"},"spending_account_prn":{"type":"string","nullable":true,"description":"The PRN of the RTF spending account"},"original_incremental_id":{"type":"integer","format":"int32","nullable":true,"description":"The original incremental id. The id for the first incremental transaction"},"latest_incremental_id":{"type":"integer","format":"int32","nullable":true,"description":"The latest incremental id. The id for the most recent transaction"}},"required":["act_id","act_type","amt","auth_ts","bal_id","description","details","mcc","pmt_ref_no","post_ts","prod_id","source_id","trans_code"]}}},"required":["end_date","number_of_pages","page","start_date","total_record_count","transaction_count","transactions"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.065,\n \"response_data\": {\n \"start_date\": \"2025-12-01 00:00:00\",\n \"end_date\": \"2025-07-13 23:59:59\",\n \"number_of_pages\": 1,\n \"page\": 1,\n \"total_record_count\": 4,\n \"transaction_count\": 4,\n \"transactions\": [\n {\n \"pmt_ref_no\": \"001108537422\",\n \"act_id\": \"122876467\",\n \"act_type\": \"AD\",\n \"mcc\": \"534882\",\n \"post_ts\": \"2025-01-17 10:01:06\",\n \"amt\": \"-5\",\n \"details\": \"test adj\",\n \"description\": \"Adjustment\",\n \"source_id\": \"52621\",\n \"bal_id\": \"425782\",\n \"prod_id\": \"88\",\n \"auth_ts\": \"2025-01-17 10:01:06\",\n \"trans_code\": \"ADF\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": \"60130481\",\n \"original_auth_id\": \"0\",\n \"network_code\": \"?\",\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"merchant_id\": \"\",\n \"formatted_merchant_desc\": \"\",\n \"terminal_id\": \"\",\n \"card_id\": \"0\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\"\n },\n {\n \"pmt_ref_no\": \"001108537422\",\n \"act_id\": \"122876352\",\n \"act_type\": \"FE\",\n \"mcc\": \"5344778\",\n \"post_ts\": \"2025-01-17 09:46:43\",\n \"amt\": \"-9.95\",\n \"details\": \"Activation Fee\",\n \"description\": \"Fee\",\n \"source_id\": \"690045\",\n \"bal_id\": \"425782\",\n \"prod_id\": \"88\",\n \"auth_ts\": \"2025-01-17 09:46:43\",\n \"trans_code\": \"FE0201\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": \"\",\n \"original_auth_id\": \"0\",\n \"network_code\": \"?\",\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"merchant_id\": \"\",\n \"formatted_merchant_desc\": \"\",\n \"terminal_id\": \"\",\n \"card_id\": \"0\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\"\n },\n {\n \"pmt_ref_no\": \"001108537448\",\n \"act_id\": \"122876160\",\n \"act_type\": \"AD\",\n \"mcc\": \"53463221\",\n \"post_ts\": \"2025-01-17 09:23:16\",\n \"amt\": \"-5\",\n \"details\": \"test adj\",\n \"description\": \"Adjustment\",\n \"source_id\": \"52618\",\n \"bal_id\": \"425782\",\n \"prod_id\": \"1068\",\n \"auth_ts\": \"2025-01-17 09:23:16\",\n \"trans_code\": \"ADF\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": \"66659246\",\n \"original_auth_id\": \"0\",\n \"network_code\": \"?\",\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"merchant_id\": \"\",\n \"formatted_merchant_desc\": \"\",\n \"terminal_id\": \"\",\n \"card_id\": \"0\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\"\n },\n {\n \"pmt_ref_no\": \"001108537430\",\n \"act_id\": \"122876046\",\n \"act_type\": \"PM\",\n \"mcc\": \"534882\",\n \"post_ts\": \"2025-01-17 09:09:16\",\n \"amt\": \"100\",\n \"details\": \"Retail Load\",\n \"description\": \"Payment\",\n \"source_id\": \"3792011\",\n \"bal_id\": \"425782\",\n \"prod_id\": \"1067\",\n \"auth_ts\": \"2025-01-17 09:09:16\",\n \"trans_code\": \"PMRL\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": \"T6NJAH3TV5SL2UXHSSO7\",\n \"original_auth_id\": \"0\",\n \"network_code\": \"?\",\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"merchant_id\": \"\",\n \"formatted_merchant_desc\": \"\",\n \"terminal_id\": \"\",\n \"card_id\": null,\n \"iac_tax\": \"0\",\n \"iva_tax\": \"4567.9876\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"PA11CRHVK1ILQWK3WSN6\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:32:15\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.075\n \n 2025-12-01 00:00:00\n 2025-07-13 23:59:59\n 1\n 1\n 3\n 3\n \n \n 001108537430\n 122876373\n AD\n 534882\n 2025-01-17 09:49:16\n -5\n test adj \n Adjustment\n 52619\n 425782\n 1067\n 2025-01-17 09:49:16\n ADF\n \n 76852773\n 0\n ?\n \n \n \n \n \n \n \n \n \n 0\n 0\n 0\n \n \n 001108537448\n 122876160\n AD\n 5344778\n 2025-01-17 09:23:16\n -5\n test adj \n Adjustment\n 52618\n 425782\n 1068\n 2025-01-17 09:23:16\n ADF\n \n 66659246\n 0\n ?\n \n \n \n \n \n \n \n \n \n 0\n 0\n 0\n \n \n 001108537430\n 122876046\n PM\n 53463221\n 2025-01-17 09:09:16\n 100\n Retail Load \n Payment\n 3792011\n 425782\n 1067\n 2025-01-17 09:09:16\n PMRL\n \n T6NJAH3TV5SL2UXHSSO7\n 0\n ?\n \n \n \n \n \n \n \n \n \n \n 0\n 0\n \n \n \n \n \n \n 2JDT56HUK8EOW5VPAYRM\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:27:47\n"}}}},"description":""}},"parameters":[],"summary":"Get Transaction History","description":"Use the Get Transaction History endpoint to retrieve a list of posted transactions (settlements, payments, adjustments, fees) during a specified timespan. This endpoint does not return unsettled authorizations.\n- As desired, use the `act_type` field in the response to filter the responses by transaction type.\n- See Record-Set Pagination for instructions on using the paging parameters.\n- Open the Recipe below to see a response example.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"startDate":{"type":"string","format":"date","description":"The beginning date for the date range, either a date or a date-time.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"endDate":{"type":"string","format":"date","description":"The end date for the date range, either a date or a date-time. Must be equal to or later than `startDate`. Max 1098 days (~3 years) after `startDate`. \nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"recordCnt":{"type":"integer","format":"int32","nullable":true,"minimum":1,"maximum":99999,"description":"The maximum number of records per page to be returned.\nPattern: Positive integer `1-99999`\nExample: `100`","example":100},"page":{"type":"integer","format":"int32","default":1,"nullable":true,"description":"The number of the page to retrieve.\nPattern: Integer value of `1` or greater\nExample: `3`","example":3},"includeRelated":{"type":"integer","format":"int32","default":1,"enum":[0,1],"description":"Whether to return transactions for all accounts that share the balance (`bal_id`). \n- `0` — Retrieve only transactions from the specified account. \n- `1` — **Default**. Retrieve all transactions that share the same balance. \n\nPattern: Integer\nExample: `0`","example":0}},"required":["accountNo","endDate","startDate","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Transactions"],"operationId":"post_gettranshistory"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getBalance":{"post":{"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"ledger_balance":{"type":"number","format":"float","description":"The total of all transactions—credit and debit—that have officially been posted to the account. This balance does not factor in pending transactions such as authorization holds or account holds."},"balance":{"type":"number","format":"float","description":"For debit accounts, this is the available balance to spend, meaning the total of all posted transactions with all pending transactions subtracted out. For credit accounts this is the unpaid balance."},"available_balance":{"type":"number","format":"float","description":"For debit accounts, this is the total of all posted transactions with all pending transactions subtracted out. Also known as the \"open to buy.\" See Available balance for details. For credit accounts, this is the amount remaining of the credit limit."},"balance_without_pending":{"type":"string","description":"For debit accounts, the total of all posted transactions with only pending authorizations subtracted out. For credit accounts this is the same as `balance`. "},"currency_code":{"type":"string","description":"A three-digit ISO 4217 code for the currency of the account. All amounts in this response are in this currency."},"pending_adjustments":{"type":"number","format":"float","nullable":true,"description":"**To be deprecated**: This field will always be `0`."},"pending_billpay":{"type":"number","format":"float","nullable":true,"description":"The total amount of pending bill payments. A bill payment is pending between the time it is created and when the amount is adjusted out of the account."},"pending_purchase":{"type":"number","format":"float","nullable":true,"description":"**To be deprecated**: This field will always be `0`."},"balance_without_auths":{"type":"number","format":"float","description":"The `balance` without subtracting out authorization holds. This field is populated only when the BWOOA parameter is set."}},"required":["available_balance","balance","balance_without_pending","currency_code","ledger_balance","pending_adjustments","pending_billpay","pending_purchase"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.088,\n \"response_data\": {\n \"balance\": 1218.2,\n \"available_balance\": 1218.2,\n \"balance_without_pending\": \"1218.20\",\n \"currency_code\": \"840\",\n \"pending_adjustments\": 0,\n \"pending_billpay\": 0,\n \"pending_purchase\": 0,\n \"ledger_balance\": 1241.7,\n \"balance_without_auths\": 1238.2\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"CUXXD4AEUMWOBMPKYBZ8\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:31:56\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.098\n \n 1234.7\n 1234.7\n 1234.7\n 840\n 0\n 0\n 0\n 1241.7\n 1254.7\n \n \n \n \n G9FMERIBYQF8L30JFPLF\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:27:18\n"}}}},"description":""}},"parameters":[],"summary":"Get Balance","description":"Use the Get Balance endpoint to retrieve the specified account balance and its currency code. This endpoint returns the balances for all accounts that share the same balance ID (Galileo account number). For an explanation of the fields in the response, see Get Balance fields in the _Account Balances_ guide.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Accounts and Cards"],"operationId":"post_getbalance"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getAuthHistory":{"post":{"description":"Use the Get Authorization History endpoint to retrieve a list of authorizations. By default it returns authorizations that have not settled, expired, or been reversed.\nYou can return authorizations in any status by setting `includeAllStatuses`.\n- See Record-Set Pagination for instructions on using the paging parameters.\n- Open the Recipe below to see a response example.","operationId":"post_getauthhistory","parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"accountNo":{"description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228","pattern":"^.+$","type":"string"},"apiLogin":{"description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999","type":"string"},"apiTransKey":{"description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g","type":"string"},"cardId":{"description":"Supply the cardId (CAD) to filter authorization history to those transactions performed on the provided card.","example":"12345","nullable":true,"type":"integer"},"endDate":{"description":"The end date for the date range, either a date or a date-time. Must be equal to or later than `startDate`. Max 1098 days (~3 years) after `startDate`. \nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01","format":"date","type":"string"},"includeAllStatuses":{"description":"When true, include transactions in all statuses. When not set, return transactions in the \"pending\" statuses.\n \nPattern: Boolean\nExample: `0`","example":0,"nullable":true,"type":"boolean"},"includeExtendedRiskData":{"description":"When true, include extended risk data.\n \nPattern: Boolean\nExample: `0`","example":0,"nullable":true,"type":"boolean"},"includeRelated":{"description":"Whether to return transactions from accounts that share the same balance (`galileo_account_number`). \n\nWhen `accountNo` contains a primary account:\n- `0` or `1` — Retrieve all transactions from accounts that share the same balance. \n- _blank_ — Retrieve all transactions from the specified account only.\n\nWhen `accountNo` contains a secondary account:\n- `0` — Retrieve all transactions from the specified account only. \n- `1` — Retrieve all transactions from accounts that share the same balance.\n \nPattern: Boolean\nExample: `0`","example":0,"nullable":true,"type":"boolean"},"page":{"default":1,"description":"The number of the page to retrieve.\nPattern: Integer value of `1` or greater\nExample: `3`","example":3,"maximum":999999,"minimum":1,"nullable":true,"type":"integer"},"recordCnt":{"description":"The maximum number of records per page to be returned.\nPattern: Positive integer `1-99999`\nExample: `100`","example":100,"maximum":99999,"minimum":1,"nullable":true,"type":"integer"},"startDate":{"description":"The beginning date for the date range, either a date or a date-time.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01","format":"date","type":"string"},"transactionId":{"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000","maxLength":60,"minLength":1,"type":"string"}},"required":["accountNo","endDate","startDate","transactionId","apiLogin","apiTransKey","providerId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"echo":{"anyOf":[{"additionalProperties":false,"properties":{"provider_timestamp":{"description":"Store a related timestamp for reporting and troubleshooting purposes","format":"date-time","nullable":true,"type":"string"},"provider_transaction_id":{"description":"Secondary transaction identifier (generated by a provider)","nullable":true,"type":"string"},"transaction_id":{"description":"An ID that represents an API transaction","nullable":true,"type":"string"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure that contains transaction ID information"},"errors":{"description":"A list of errors generated while the request was processed","items":{"type":"string"},"type":"array"},"processing_time":{"description":"The time elapsed in processing the transaction","nullable":true,"type":"number"},"response_data":{"anyOf":[{"additionalProperties":false,"properties":{"authorizations":{"description":"List of authorizations","items":{"additionalProperties":false,"properties":{"acq_id":{"description":"The identifier for the acquirer (DE032)","type":"string"},"amount":{"description":"The authorization amount, in the currency of the account","type":"string"},"auth_id":{"description":"A system-generated identifier for an authorization.","type":"string"},"billing_amt":{"description":"The billing amount in cents (DE006). 12-digit number including leading zeros.","nullable":true,"type":"string"},"billing_curr_code":{"description":"Currency code for `billing_amt` (DE051)","nullable":true,"type":"string"},"can_be_expired":{"description":"Whether to allow an expiration on this authorization: `1` = Allow, or `0` = Do not allow","type":"string"},"details":{"description":"Description provided by the merchant about the transaction (DE043)","type":"string"},"details_formatted":{"description":"The same information as in the `details` field, with formatting","type":"string"},"iac_tax":{"description":"Impuesto al Consumo. Colombian consumption tax. Required for the Mastercard Interchange Intracountry Calculation Program.","nullable":true,"type":"number"},"iva_tax":{"description":"Impuesto al Valor Agregado. Colombian value-added tax. Required for the Mastercard Interchange Intracountry Calculation Program.","nullable":true,"type":"number"},"latest_incremental_id":{"description":"The `auth_id` of the previous authorization in an incremental sequence, if any. This field contains the same information as `original_auth_id` and is present only by request.","nullable":true,"type":"string"},"local_amt":{"description":"Amount in cents of the transaction based on the currency at the point of sale (DE004). 12-digit number including leading zeros.","nullable":true,"type":"string"},"local_curr_code":{"description":"Currency code for `local_amt` (DE049)","nullable":true,"type":"string"},"mcc":{"description":"Category code for the merchant that initiated the transaction (DE018)","type":"string"},"merchant_id":{"description":"Network-assigned identifier for a merchant (DE042)","type":"string"},"network_code":{"description":"A system-generated code to identify the network over which the transaction took place. Maps to `network_id`.","nullable":true,"type":"string"},"original_auth_id":{"description":"The `auth_id` of the previous transaction in the sequence, if any. Maps to `prior_id` in other contexts.","nullable":true,"type":"string"},"original_incremental_id":{"description":"The `auth_id` of the first authorization in an incremental sequence, if any. This field is present only by request.","nullable":true,"type":"string"},"settle_amt":{"description":"The transaction amount, in cents, in the settlement currency (DE005). 12-digit number including leading zeros.","nullable":true,"type":"string"},"settle_curr_code":{"description":"Currency code for `settle_amt` (DE050)","nullable":true,"type":"string"},"terminal_id":{"description":"Identifier for the card reader at the point of sale (DE041)","type":"string"},"timestamp":{"description":"The system timestamp for the authorization, in our system time","format":"date-time","nullable":true,"type":"string"},"type":{"description":"Reference your program's authorization transaction types for possible values.","type":"string"}},"required":["acq_id","amount","auth_id","billing_amt","billing_curr_code","can_be_expired","details","details_formatted","local_amt","local_curr_code","mcc","merchant_id","network_code","original_auth_id","settle_amt","settle_curr_code","terminal_id","timestamp","type"],"type":"object"},"type":"array"},"number_of_pages":{"description":"Total number of pages in the authorizations","type":"integer"},"page":{"description":"The page number retrieved in the context of recordset paging","type":"integer"},"total_record_count":{"description":"The number of records in the authorizations","type":"integer"}},"required":["authorizations","number_of_pages","page","total_record_count"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure for the response data. It can be empty but usually will contain information."},"rtoken":{"description":"A system-generated ID used for tracking","nullable":true,"type":"string"},"status":{"description":"The condition of a process or response","nullable":true,"type":"string"},"status_code":{"description":"The response status code. May return a string for some statuses.","nullable":true,"type":"integer"},"system_timestamp":{"description":"A system generated timestamp","format":"date-time","nullable":true,"type":"string"}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"],"type":"object"},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.074,\n \"response_data\": {\n \"authorizations\": [\n {\n \"auth_id\": \"14125\",\n \"details\": \"TEST MERCHANT ALT LAKE UTUS\",\n \"details_formatted\": \"TEST MERCHANT, ALT LAKE, UT\",\n \"amount\": \"-25\",\n \"timestamp\": \"2025-08-30 10:01:14\",\n \"type\": \"L\",\n \"mcc\": \"4972\",\n \"merchant_id\": \"W5K5YS33J7LRJR4\",\n \"acq_id\": \"03695\",\n \"terminal_id\": \"FHFUJ0DH\",\n \"can_be_expired\": \"1\",\n \"original_auth_id\": \"0\",\n \"network_code\": \"V\",\n \"local_amt\": \"000000002500\",\n \"local_curr_code\": \"840\",\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\"\n },\n {\n \"auth_id\": \"14779\",\n \"details\": \"TEST MERCHANT ALT LAKE UTUS\",\n \"details_formatted\": \"TEST MERCHANT, ALT LAKE, UT\",\n \"amount\": \"-25\",\n \"timestamp\": \"2025-09-04 13:18:16\",\n \"type\": \"L\",\n \"mcc\": \"4856\",\n \"merchant_id\": \"XB550UD2NEWTASS\",\n \"acq_id\": \"437660\",\n \"terminal_id\": \"HJ59NQ27\",\n \"can_be_expired\": \"1\",\n \"original_auth_id\": \"0\",\n \"network_code\": \"V\",\n \"local_amt\": \"000000002500\",\n \"local_curr_code\": \"840\",\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"iac_tax\": \"0\",\n \"iva_tax\": \"4567\"\n },\n {\n \"auth_id\": \"14825\",\n \"details\": \"TEST MERCHANT ALT LAKE UTUS\",\n \"details_formatted\": \"TEST MERCHANT, ALT LAKE, UT\",\n \"amount\": \"-25\",\n \"timestamp\": \"2025-09-04 14:45:11\",\n \"type\": \"L\",\n \"mcc\": \"4083\",\n \"merchant_id\": \"XVVFISDR7NM4NZS\",\n \"acq_id\": \"137723\",\n \"terminal_id\": \"FJZ2GD43\",\n \"can_be_expired\": \"1\",\n \"original_auth_id\": \"0\",\n \"network_code\": \"V\",\n \"local_amt\": \"000000002500\",\n \"local_curr_code\": \"840\",\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"iac_tax\": \"0\",\n \"iva_tax\": \"4567.9876\"\n },\n {\n \"auth_id\": \"63\",\n \"details\": \"98AOMFZ3ZUSHMB7 220 CT SALT LAKE US\",\n \"details_formatted\": \"98AOMFZ3ZUSHMB7 220 CT SALT LAKE US\",\n \"amount\": \"-25\",\n \"timestamp\": \"2025-09-17 15:00:37\",\n \"type\": \"M\",\n \"mcc\": \"6011\",\n \"merchant_id\": \"98AOMFZ3ZUSHMB7\",\n \"acq_id\": \"012563\",\n \"terminal_id\": \"LLZRP3OL\",\n \"can_be_expired\": \"1\",\n \"original_auth_id\": \"0\",\n \"network_code\": \"S\",\n \"local_amt\": \"000000002500\",\n \"local_curr_code\": \"840\",\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\"\n },\n {\n \"auth_id\": \"62\",\n \"details\": \"98AOMFZ3ZUSHMB7 220 CT SALT LAKE US\",\n \"details_formatted\": \"98AOMFZ3ZUSHMB7 220 CT SALT LAKE US\",\n \"amount\": \"-25\",\n \"timestamp\": \"2025-09-17 15:00:37\",\n \"type\": \"M\",\n \"mcc\": \"6011\",\n \"merchant_id\": \"98AOMFZ3ZUSHMB7\",\n \"acq_id\": \"012563\",\n \"terminal_id\": \"LLZRP3OL\",\n \"can_be_expired\": \"1\",\n \"original_auth_id\": \"0\",\n \"network_code\": \"S\",\n \"local_amt\": \"000000002500\",\n \"local_curr_code\": \"840\",\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"iac_tax\": \"0\",\n \"iva_tax\": \"4567.9876\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"82KE6A1RUQ5HPX69TY4L\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:31:56\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.076\n \n \n \n 14125\n TEST MERCHANT ALT LAKE UTUS \n TEST MERCHANT, ALT LAKE, UT\n -25\n 2025-08-30 10:01:14\n L\n 4972\n W5K5YS33J7LRJR4\n 03695\n FHFUJ0DH\n 1\n 0\n V\n 000000002500\n 840\n \n \n \n \n 0\n 0\n \n \n 14779\n TEST MERCHANT ALT LAKE UTUS \n TEST MERCHANT, ALT LAKE, UT\n -25\n 2025-09-04 13:18:16\n L\n 4856\n XB550UD2NEWTASS\n 437660\n HJ59NQ27\n 1\n 0\n V\n 000000002500\n 840\n \n \n \n \n 0\n 4567.9876\n \n \n 14825\n TEST MERCHANT ALT LAKE UTUS \n TEST MERCHANT, ALT LAKE, UT\n -25\n 2025-09-04 14:45:11\n L\n 4083\n XVVFISDR7NM4NZS\n 137723\n FJZ2GD43\n 1\n 0\n V\n 000000002500\n 840\n \n \n \n \n 0\n 4567.9876\n \n \n 63\n 98AOMFZ3ZUSHMB7 220 CT SALT LAKE US \n 98AOMFZ3ZUSHMB7 220 CT SALT LAKE US\n -25\n 2025-09-17 15:00:37\n M\n 6011\n 98AOMFZ3ZUSHMB7\n 012563\n LLZRP3OL\n 1\n 0\n S\n 000000002500\n 840\n \n \n \n \n 0\n 0\n \n \n 62\n 98AOMFZ3ZUSHMB7 220 CT SALT LAKE US \n 98AOMFZ3ZUSHMB7 220 CT SALT LAKE US\n -25\n 2025-09-17 15:00:37\n M\n 6011\n 98AOMFZ3ZUSHMB7\n 012563\n LLZRP3OL\n 1\n 0\n S\n 000000002500\n 840\n \n \n \n \n 0\n 4567.9876\n \n \n \n \n \n \n 15FTBIF1UOB2EZ3RRJ9I\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:27:16\n"}}}},"description":"Successful response"}},"summary":"Get Authorization History","tags":["Transactions"]},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getAccountOverview":{"post":{"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"pmt_ref_no":{"type":"string","description":"Payment reference number."},"status":{"type":"string","description":"Status of the account"},"first_fund_date":{"type":"string","format":"date","nullable":true,"description":"Date the account was first funded"},"application_date":{"type":"string","format":"date","nullable":true,"description":"Date the account application was received"},"balance":{"type":"number","format":"float","description":"The current account balance"},"currency_code":{"type":"string","description":"A three-character code to represent global currencies"},"profile":{"type":"object","properties":{"id":{"type":"string","description":"Account holder's primary ID"},"id2":{"type":"string","nullable":true,"description":"Account holder's secondary ID"},"id3":{"type":"string","nullable":true,"description":"Account holder's tertiary ID"},"id_type":{"type":"integer","format":"int32","description":"The ID type for `id`. See Customer ID Types for valid values"},"id2_type":{"type":"integer","format":"int32","nullable":true,"description":"The ID type for `id2`"},"id3_type":{"type":"integer","format":"int32","nullable":true,"description":"The ID type for `id3`"},"first_name":{"type":"string","description":"Account holder's first name"},"middle_name":{"type":"string","nullable":true,"description":"Account holder's middle name"},"last_name":{"type":"string","description":"Account holder's last name"},"address_1":{"type":"string","nullable":true,"description":"First line of the account holder's address"},"address_2":{"type":"string","nullable":true,"description":"Second line of the account holder's address"},"business_name":{"type":"string","nullable":true,"description":"Business name on the account"},"city":{"type":"string","nullable":true,"description":"Account holder's city"},"state":{"type":"string","description":"Account holder's state"},"postal_code":{"type":"string","description":"Account holder's postal code"},"country_code":{"type":"string","nullable":true,"description":"The ISO 3166 international standard for country codes. Identifies the account holder's country."},"home_phone":{"type":"string","nullable":true,"description":"Account holder's home phone number"},"mobile_phone":{"type":"string","nullable":true,"description":"Account holder's mobile phone number"},"mobile_phone_country_code":{"type":"string","nullable":true,"description":"Account holder's mobile phone country code"},"carrier_id":{"type":"integer","format":"int32","nullable":true,"description":"Account holder's mobile phone carrier ID"},"email":{"type":"string","nullable":true,"description":"Account holder's email address"},"dob":{"type":"string","format":"date","nullable":true,"description":"Account holder's date of birth"},"ship_to_address":{"type":"object","properties":{"address_1":{"type":"string","nullable":true,"description":"First line of the shipping address"},"address_2":{"type":"string","nullable":true,"description":"Second line of the shipping address"},"city":{"type":"string","nullable":true,"description":"City for the shipping address"},"state":{"type":"string","nullable":true,"description":"State for the shipping address"},"postal_code":{"type":"string","nullable":true,"description":"Postal code for the shipping address"},"country_code":{"type":"string","nullable":true,"description":"ISO 3166 country code indicating the country for the shipping address"}},"required":["address_1","address_2","city","country_code","postal_code","state"]},"express_mail":{"type":"string","nullable":true,"description":"Indicates whether to use express mail for shipping"},"occupation":{"type":"string","nullable":true,"description":"Account holder's occupation"},"income_source":{"type":"string","nullable":true,"description":"Account holder's income source"},"monthly_income":{"type":"string","nullable":true,"description":"Account holder's monthly income"},"preferred_lang":{"type":"string","nullable":true,"description":"Account holder's preferred language"},"preferred_name":{"type":"string","nullable":true}},"required":["address_1","address_2","business_name","city","country_code","dob","email","first_name","home_phone","id","id_type","last_name","middle_name","mobile_phone","postal_code","ship_to_address","state"]},"start_date":{"type":"string","format":"date-time","nullable":true,"description":"The start date for the range that account information is displayed"},"end_date":{"type":"string","format":"date-time","nullable":true,"description":"The end date for the range that account information is displayed"},"transaction_count":{"type":"integer","format":"int32","description":"The number of transactions listed in the response"},"transactions":{"type":"array","description":"List of transactions","items":{"type":"object","properties":{"pmt_ref_no":{"type":"string","description":"Payment reference number."},"act_id":{"type":"string","nullable":true,"description":"Transaction activity identifier used in the SoFi Tech Solutions system"},"act_type":{"type":"string","nullable":true,"description":"Identifier for the transaction activity type. See the Activity Type enumeration."},"mcc":{"type":"string","description":"Merchant Category Code (MCC) for the merchant that initiated the transaction (DE018)"},"post_ts":{"type":"string","format":"date-time","nullable":true,"description":"The system timestamp when the transaction posted to the customer account, in our system time"},"amt":{"type":"string","description":"The transaction amount in the currency of the account. A negative amount debits funds from the customer account."},"details":{"type":"string","description":"Description provided by the merchant about the transaction (DE043)"},"description":{"type":"string","nullable":true,"description":"Description of the activity type (`act_type`). See the Activity Type enumeration."},"source_id":{"type":"string","description":"System-generated identifier that maps to the original transaction, such as `auth_id`, `pmt_id`, or `adj_id`"},"bal_id":{"type":"string","description":"Balance ID, a system-generated identifier for the account on which the transaction occurs. Maps to `galileo_account_number`."},"prod_id":{"type":"string","description":"Identifier for the product associated with the account"},"auth_ts":{"type":"string","format":"date-time","description":"System timestamp when the transaction was authorized, in our system time"},"trans_code":{"type":"string","description":"Reference your program's activity and transaction types for possible values."},"ach_transaction_id":{"type":"string","nullable":true,"description":"Identifier for the ACH transaction, if applicable"},"external_trans_id":{"type":"string","nullable":true,"description":"Optional identifier for a transaction that you supply. External to the system."},"original_auth_id":{"type":"string","nullable":true,"description":"The `auth_id` of the previous transaction in the sequence, if any. Maps to `prior_id`."},"network_id":{"type":"string","nullable":true,"description":"A system-generated code to identify the subnetwork over which the transaction took place. Maps to `network_code`."},"local_amt":{"type":"string","nullable":true,"description":"Amount of the authorization request at the point of sale. Unsigned. This amount does not include upcharges or program fees. In the `authorizations` object, this amount is displayed in cents. (DE004)"},"local_curr_code":{"type":"string","nullable":true,"description":"Currency code for `local_amt` (DE049)"},"settle_amt":{"type":"string","nullable":true,"description":"The transaction amount, in cents, in the settlement currency (DE005). 12-digit number including leading zeros."},"settle_curr_code":{"type":"string","nullable":true,"description":"Currency code for `settle_amt` (DE050)"},"billing_amt":{"type":"string","nullable":true,"description":"The transaction amount, in cents, in the currency of the account (DE006). 12-digit number including leading zeros."},"billing_curr_code":{"type":"string","nullable":true,"description":"Currency code for `billing_amt` (DE051)"},"credit_ind":{"type":"string","nullable":true,"description":"Indicates whether a PIN was input at the point of sale. `Y` = No PIN was input. `N` = A PIN was input. `None` = Not a card transaction, or not processed as a card transaction."},"iac_tax":{"type":"number","format":"float","nullable":true,"description":"Impuesto al Consumo. Colombian consumption tax. Required for the Mastercard Interchange Intracountry Calculation Program."},"iva_tax":{"type":"number","format":"float","nullable":true,"description":"Impuesto al Valor Agregado. Colombian value-added tax. Required for the Mastercard Interchange Intracountry Calculation Program."},"funding_account_prn":{"type":"string","nullable":true,"description":"The <> of the <> funding account"},"spending_account_prn":{"type":"string","nullable":true,"description":"The PRN of the RTF spending account"}},"required":["ach_transaction_id","act_id","act_type","amt","auth_ts","bal_id","billing_amt","billing_curr_code","credit_ind","description","details","external_trans_id","local_amt","local_curr_code","mcc","network_id","original_auth_id","pmt_ref_no","post_ts","prod_id","settle_amt","settle_curr_code","source_id","trans_code"]}},"authorization_count":{"type":"integer","format":"int32","description":"The number of authorizations listed in the response"},"authorizations":{"type":"array","description":"List of authorizations","items":{"type":"object","properties":{"auth_id":{"type":"string","description":"A system-generated identifier for an authorization."},"details":{"type":"string","description":"Description provided by the merchant about the transaction (DE043)"},"details_formatted":{"type":"string","description":"The same information as in the `details` field, with formatting"},"amount":{"type":"string","description":"The authorization amount, in the currency of the account"},"timestamp":{"type":"string","format":"date-time","nullable":true,"description":"The system timestamp for the authorization, in our system time"},"type":{"type":"string","description":"Reference your program's authorization transaction types for possible values."},"mcc":{"type":"string","description":"Category code for the merchant that initiated the transaction (DE018)"},"merchant_id":{"type":"string","description":"Network-assigned identifier for a merchant (DE042)"},"acq_id":{"type":"string","description":"The identifier for the acquirer (DE032)"},"terminal_id":{"type":"string","description":"Identifier for the card reader at the point of sale (DE041)"},"can_be_expired":{"type":"string","description":"Whether to allow an expiration on this authorization: `1` = Allow, or `0` = Do not allow"},"original_auth_id":{"type":"string","nullable":true,"description":"The `auth_id` of the previous transaction in the sequence, if any. Maps to `prior_id` in other contexts."},"network_code":{"type":"string","nullable":true,"description":"A system-generated code to identify the network over which the transaction took place. Maps to `network_id`."},"local_amt":{"type":"string","nullable":true,"description":"Amount in cents of the transaction based on the currency at the point of sale (DE004). 12-digit number including leading zeros."},"local_curr_code":{"type":"string","nullable":true,"description":"Currency code for `local_amt` (DE049)"},"settle_amt":{"type":"string","nullable":true,"description":"The transaction amount, in cents, in the settlement currency (DE005). 12-digit number including leading zeros."},"settle_curr_code":{"type":"string","nullable":true,"description":"Currency code for `settle_amt` (DE050)"},"billing_amt":{"type":"string","nullable":true,"description":"The billing amount in cents (DE006). 12-digit number including leading zeros."},"billing_curr_code":{"type":"string","nullable":true,"description":"Currency code for `billing_amt` (DE051)"},"iac_tax":{"type":"number","format":"float","nullable":true,"description":"Impuesto al Consumo. Colombian consumption tax. Required for the Mastercard Interchange Intracountry Calculation Program."},"iva_tax":{"type":"number","format":"float","nullable":true,"description":"Impuesto al Valor Agregado. Colombian value-added tax. Required for the Mastercard Interchange Intracountry Calculation Program."},"latest_incremental_id":{"type":"string","nullable":true,"description":"The `auth_id` of the previous authorization in an incremental sequence, if any. This field contains the same information as `original_auth_id` and is present only by request."},"original_incremental_id":{"type":"string","nullable":true,"description":"The `auth_id` of the first authorization in an incremental sequence, if any. This field is present only by request."},"pmt_ref_no":{"type":"string","description":"Payment reference number."},"bal_id":{"type":"string","description":"Balance ID, a system-generated identifier for the account on which the transaction occurs. Maps to `galileo_account_number`."}},"required":["acq_id","amount","auth_id","bal_id","billing_amt","billing_curr_code","can_be_expired","details","details_formatted","local_amt","local_curr_code","mcc","merchant_id","network_code","original_auth_id","pmt_ref_no","settle_amt","settle_curr_code","terminal_id","timestamp","type"]}},"pending_fees":{"type":"array","description":"List of fees","items":{"type":"object","properties":{"fee_event_id":{"type":"string","description":"System-generated fee transaction integer ID"},"type":{"type":"string","description":"Three-letter fee code. This is not the transaction type (otype)."},"type_description":{"type":"string","description":"A description of the type code"},"amt":{"type":"string","description":"Amount of the fee charge"},"fee_date":{"type":"string","format":"date-time","description":"A timestamp for the time the fee was charged"},"card_id":{"type":"integer","format":"int32","nullable":true,"description":"Integer identifier of the card as found in the raw data file (RDF). Unique identifier for a PAN."},"fee_description":{"type":"string","description":"The description on a fee"},"related_transaction":{"nullable":true,"description":"A data structure that contains information on transactions related to a fee","type":"object","properties":{"details":{"type":"string","nullable":true,"description":"Information on a transaction or authorization"},"amt":{"type":"number","format":"float","description":"Amount of a fee or transaction charge"},"post_ts":{"type":"string","format":"date-time","description":"The time stamp of a posted transaction"}},"required":["amt","details","post_ts"]}},"required":["amt","card_id","fee_date","fee_description","fee_event_id","related_transaction","type","type_description"]}},"savings_interest":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time","description":"The start date for the period"},"end_date":{"type":"string","format":"date-time","description":"The end date for the period"},"accrual_interest":{"description":"Interest accrued on the account. May return an integer if the interest accrued is 0."},"interest_ytd":{"description":"The year-to-date interest paid on a savings account. May return an integer if the interest paid is 0."},"apy":{"description":"The Annual Percentage Yield Earned (APYE) for the requested month"}},"required":["accrual_interest","apy","end_date","interest_ytd","start_date"]},"holds":{"type":"array","description":"List of holds. Holds being returned are dependant on product parameters","items":{"type":"object","properties":{"hold_id":{"type":"string","description":"Identifier for the hold"},"create_dt":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the hold was created"},"expiry_dt":{"type":"string","format":"date-time","nullable":true,"description":"Date the hold expires"},"source_id":{"type":"string","nullable":true,"description":"Source ID for the hold"},"change_ts":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the hold was changed"},"hold_type":{"type":"string","nullable":true,"description":"Identifier for the hold type"},"ext_id":{"type":"string","nullable":true,"description":"External identifier for the hold"},"dscr":{"type":"string","nullable":true,"description":"Description of the hold"},"originating_system_id":{"type":"string","nullable":true,"description":"Identifier that specifies the source system for the hold"},"agent_id":{"type":"string","nullable":true,"description":"Identifier for the agent that created the hold"},"amount":{"type":"number","format":"float","description":"The amount for the hold"},"xid":{"type":"string","nullable":true,"description":"The transaction ID associated with the hold"},"expiring_system_id":{"type":"string","nullable":true,"description":"Identifier for the process that expired the hold"},"expiring_agent_id":{"type":"string","nullable":true,"description":"Identifier for the agent that expired the hold"}},"required":["agent_id","amount","create_dt","dscr","expiring_agent_id","expiring_system_id","expiry_dt","ext_id","hold_id","hold_type","originating_system_id","source_id","xid"]}},"kyc_ref_no":{"type":"string","nullable":true,"description":"A know-your-customer (KYC) reference number for the account"},"curp":{"type":"string","nullable":true,"description":"Clave Única de Registro de Población (CURP) for the account"},"political_affiliation":{"type":"boolean","nullable":true,"description":"Whether the account is associated with a politically exposed person"},"place_of_birth":{"type":"string","nullable":true,"description":"Place of birth of the account holder in ISO-3166-2 format: `XX-XX`. For example, `US-NY`"},"nationality":{"type":"string","nullable":true,"description":"Nationality of the account holder in ISO-3166-1 format (2 letters)"}},"required":["application_date","authorization_count","authorizations","balance","currency_code","end_date","first_fund_date","pending_fees","pmt_ref_no","profile","savings_interest","start_date","status","transaction_count","transactions"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"\n{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.082,\n \"response_data\": {\n \"pmt_ref_no\": \"999102163165\",\n \"status\": \"N\",\n \"first_fund_date\": \"2027-05-05\",\n \"application_date\": \"2027-04-04\",\n \"balance\": 1218.2,\n \"currency_code\": \"840\",\n \"profile\": {\n \"first_name\": \"Jack\",\n \"middle_name\": \"Abelard\",\n \"last_name\": \"Smith\",\n \"address_1\": \"33 Maple Street\",\n \"address_2\": \"#4b\",\n \"city\": \"Salt Lake City\",\n \"state\": \"UT\",\n \"postal_code\": \"84121\",\n \"country_code\": \"840\",\n \"home_phone\": \"8015556060\",\n \"mobile_phone\": \"8012222222\",\n \"email\": \"jasmith@emaildomain.com\",\n \"dob\": \"1980-01-01\",\n \"ship_to_address\": {\n \"address_1\": \"33 Business Parkway\",\n \"address_2\": \"Suite 400\",\n \"city\": \"Salt Lake City\",\n \"state\": \"UT\",\n \"postal_code\": \"84121\",\n \"country_code\": \"840\"\n },\n \"express_mail\": \"0\",\n \"occupation\": \"Project Manager\",\n \"income_source\": \"Kroger Food & Drug\",\n \"preferred_lang\": \"EN\",\n \"id\": \"MDAxNgytmjkDU8vh9uxMG6ocw2kK\",\n \"id2\": \"6fb41eb957374c06b066d80d022e776a\",\n \"id3\": null,\n \"id_type\": 2,\n \"id2_type\": 14,\n \"id3_type\": null,\n \"gids\": []\n },\n \"start_date\": \"2027-10-01 00:00:00\",\n \"end_date\": \"2027-12-15 23:59:59\",\n \"transaction_count\": 9,\n \"transactions\": [\n {\n \"pmt_ref_no\": \"999102163165\",\n \"act_id\": \"43878\",\n \"act_type\": \"SE\",\n \"mcc\": \"3424\",\n \"post_ts\": \"2027-11-17 12:18:33\",\n \"amt\": \"-380\",\n \"details\": \"Southern Car Rental, SALT LAKE CIT, US\",\n \"description\": \"Mastercard Settlement\",\n \"source_id\": \"1421468\",\n \"bal_id\": \"6439\",\n \"prod_id\": \"6107\",\n \"auth_ts\": \"2027-11-17 12:08:12\",\n \"trans_code\": \"SE5\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": null,\n \"original_auth_id\": \"0\",\n \"network_id\": \"M\",\n \"local_amt\": null,\n \"local_curr_code\": \"840\",\n \"settle_amt\": null,\n \"settle_curr_code\": \"840\",\n \"billing_amt\": null,\n \"billing_curr_code\": \"840\",\n \"credit_ind\": \"Y\"\n },\n {\n \"pmt_ref_no\": \"999102163165\",\n \"act_id\": \"43871\",\n \"act_type\": \"PM\",\n \"mcc\": null,\n \"post_ts\": \"2027-11-17 12:01:51\",\n \"amt\": \"539.04\",\n \"details\": \"Retail Load\",\n \"description\": \"Payment\",\n \"source_id\": \"8893\",\n \"bal_id\": \"6439\",\n \"prod_id\": \"6107\",\n \"auth_ts\": \"2027-11-17 12:01:51\",\n \"trans_code\": \"PMRL\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": \"f296950b-5089-42ca-a010-93b8c0652ed7\",\n \"original_auth_id\": \"0\",\n \"network_id\": \"?\",\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"credit_ind\": null\n },\n {\n \"pmt_ref_no\": \"999102163165\",\n \"act_id\": \"41423\",\n \"act_type\": \"FE\",\n \"mcc\": null,\n \"post_ts\": \"2027-10-21 09:24:04\",\n \"amt\": \"-2.5\",\n \"details\": \"ATM Domestic Fee\",\n \"description\": \"Fee\",\n \"source_id\": \"3611\",\n \"bal_id\": \"6439\",\n \"prod_id\": \"6107\",\n \"auth_ts\": \"2027-10-21 09:24:04\",\n \"trans_code\": \"FE0013\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": null,\n \"original_auth_id\": \"0\",\n \"network_id\": \"?\",\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"credit_ind\": null\n },\n {\n \"pmt_ref_no\": \"999102163165\",\n \"act_id\": \"41413\",\n \"act_type\": \"VS\",\n \"mcc\": \"5411\",\n \"post_ts\": \"2027-10-21 08:45:03\",\n \"amt\": \"-70\",\n \"details\": \"1-Retail, LT LAKE CITY, UTUS\",\n \"description\": \"Visa settle\",\n \"source_id\": \"11452\",\n \"bal_id\": \"6439\",\n \"prod_id\": \"6107\",\n \"auth_ts\": \"2027-10-21 08:42:59\",\n \"trans_code\": \"VSA\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": null,\n \"original_auth_id\": \"0\",\n \"network_id\": \"V\",\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"credit_ind\": \"Y\"\n },\n {\n \"pmt_ref_no\": \"999102163165\",\n \"act_id\": \"41403\",\n \"act_type\": \"VS\",\n \"mcc\": \"5411\",\n \"post_ts\": \"2027-10-21 07:48:16\",\n \"amt\": \"-20\",\n \"details\": \"3-Mercado Las Americas, LT LAKE CITY, UTUS\",\n \"description\": \"Visa settle\",\n \"source_id\": \"11447\",\n \"bal_id\": \"6439\",\n \"prod_id\": \"6107\",\n \"auth_ts\": \"2027-10-21 07:45:40\",\n \"trans_code\": \"VSA\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": null,\n \"original_auth_id\": \"0\",\n \"network_id\": \"V\",\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"credit_ind\": \"Y\"\n },\n {\n \"pmt_ref_no\": \"999102163165\",\n \"act_id\": \"41347\",\n \"act_type\": \"SE\",\n \"mcc\": \"4121\",\n \"post_ts\": \"2027-10-20 15:58:33\",\n \"amt\": \"0\",\n \"details\": \"Southern Rideshare, SALT LAKE CIT, US\",\n \"description\": \"Mastercard Settlement\",\n \"source_id\": \"1411467\",\n \"bal_id\": \"6439\",\n \"prod_id\": \"6107\",\n \"auth_ts\": \"2027-10-20 15:53:10\",\n \"trans_code\": \"SE5\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": null,\n \"original_auth_id\": \"0\",\n \"network_id\": \"M\",\n \"local_amt\": null,\n \"local_curr_code\": \"840\",\n \"settle_amt\": null,\n \"settle_curr_code\": \"840\",\n \"billing_amt\": null,\n \"billing_curr_code\": \"840\",\n \"credit_ind\": \"Y\"\n },\n {\n \"pmt_ref_no\": \"999102163165\",\n \"act_id\": \"41237\",\n \"act_type\": \"PM\",\n \"mcc\": \"4121\",\n \"post_ts\": \"2027-10-19 11:10:47\",\n \"amt\": \"100\",\n \"details\": \"Mastercard Load\",\n \"description\": \"Payment\",\n \"source_id\": \"8854\",\n \"bal_id\": \"6439\",\n \"prod_id\": \"6107\",\n \"auth_ts\": \"2027-10-19 11:10:47\",\n \"trans_code\": \"PMML\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": null,\n \"original_auth_id\": \"0\",\n \"network_id\": \"?\",\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"credit_ind\": null\n },\n {\n \"pmt_ref_no\": \"999102163165\",\n \"act_id\": \"40632\",\n \"act_type\": \"VS\",\n \"mcc\": \"4776\",\n \"post_ts\": \"2027-10-11 15:00:34\",\n \"amt\": \"-30\",\n \"details\": \"Central Restaurant, , \",\n \"description\": \"Visa settle\",\n \"source_id\": \"10702\",\n \"bal_id\": \"6439\",\n \"prod_id\": \"6107\",\n \"auth_ts\": \"2027-10-11 15:00:33\",\n \"trans_code\": \"VSM\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": null,\n \"original_auth_id\": \"0\",\n \"network_id\": \"V\",\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"credit_ind\": \"Y\"\n },\n {\n \"pmt_ref_no\": \"999102163165\",\n \"act_id\": \"40505\",\n \"act_type\": \"AD\",\n \"mcc\": null,\n \"post_ts\": \"2027-10-10 10:37:07\",\n \"amt\": \"-355\",\n \"details\": \"Adjustment\",\n \"description\": \"Adjustment\",\n \"source_id\": \"11059\",\n \"bal_id\": \"6439\",\n \"prod_id\": \"6107\",\n \"auth_ts\": \"2027-10-10 10:37:07\",\n \"trans_code\": \"AD7\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": \"112233\",\n \"original_auth_id\": \"0\",\n \"network_id\": null,\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"credit_ind\": null\n }\n ],\n \"authorization_count\": 3,\n \"authorizations\": [\n {\n \"auth_id\": \"11307\",\n \"details\": \"Central Gasoline LT LAKE CITY UTUS\",\n \"details_formatted\": \"CENTRAL GASOLINE, LT LAKE CITY, UT\",\n \"amount\": \"-75\",\n \"timestamp\": \"2027-10-19 13:53:38\",\n \"type\": \"L\",\n \"mcc\": \"5542\",\n \"merchant_id\": \"KqS4Y5hJEVr9gqW\",\n \"acq_id\": \"926253\",\n \"terminal_id\": \"99179444\",\n \"can_be_expired\": \"1\",\n \"original_auth_id\": \"0\",\n \"network_code\": \"V\",\n \"local_amt\": \"000000007500\",\n \"local_curr_code\": \"840\",\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"pmt_ref_no\": \"999102163165\",\n \"bal_id\": \"6439\"\n },\n {\n \"auth_id\": \"11318\",\n \"details\": \"Central RideshareLT LAKE CITY UTUS\",\n \"details_formatted\": \"CENTRAL RIDESHARE, LT LAKE CITY, UT\",\n \"amount\": \"-66\",\n \"timestamp\": \"2027-10-19 16:33:39\",\n \"type\": \"L\",\n \"mcc\": \"4121\",\n \"merchant_id\": \"eQCDZUUFnEn9Yx5\",\n \"acq_id\": \"622996\",\n \"terminal_id\": \"17244583\",\n \"can_be_expired\": \"1\",\n \"original_auth_id\": \"11315\",\n \"network_code\": \"V\",\n \"local_amt\": \"000000001000\",\n \"local_curr_code\": \"840\",\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"pmt_ref_no\": \"999102163165\",\n \"bal_id\": \"6439\"\n },\n {\n \"auth_id\": \"13854\",\n \"details\": \"Central Car RentalLT LAKE CITY UTUS\",\n \"details_formatted\": \"CENTRAL CAR RENTAL, LT LAKE CITY, UT\",\n \"amount\": \"-575\",\n \"timestamp\": \"2027-11-17 11:52:57\",\n \"type\": \"L\",\n \"mcc\": \"3424\",\n \"merchant_id\": \"cfzgZ8kgmEA9mJm\",\n \"acq_id\": \"947566\",\n \"terminal_id\": \"79853554\",\n \"can_be_expired\": \"1\",\n \"original_auth_id\": \"0\",\n \"network_code\": \"V\",\n \"local_amt\": \"000000050000\",\n \"local_curr_code\": \"840\",\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"pmt_ref_no\": \"999102163165\",\n \"bal_id\": \"6439\"\n }\n ],\n \"pending_fees\": [\n {\n \"fee_event_id\": \"555555\",\n \"type\": \"REP\",\n \"type_description\": \"Replacement Card Fee\",\n \"amt\": \"3\",\n \"fee_date\": \"2025-11-13 00:00:00\",\n \"card_id\": \"33333\",\n \"fee_description\": null,\n \"related_transaction\": null\n }\n ],\n \"savings_interest\": {\n \"start_date\": \"2027-10-01 00:00:00\",\n \"end_date\": \"2027-12-15 23:59:59\",\n \"accrual_interest\": 0,\n \"interest_ytd\": 0,\n \"apy\": 0\n },\n \"kyc_ref_no\": null,\n \"curp\": null,\n \"political_affiliation\": false,\n \"place_of_birth\": null,\n \"nationality\": null,\n \"holds\": [\n {\n \"hold_id\": \"4444\",\n \"create_dt\": \"2027-11-15\",\n \"expiry_dt\": \"2027-18-15\",\n \"source_id\": \"88888\",\n \"change_ts\": null,\n \"hold_type\": \"DE\",\n \"ext_id\": null,\n \"dscr\": null,\n \"originating_system_id\": \"API\",\n \"agent_id\": \"qAe5Tg-0026\",\n \"amount\": 50,\n \"xid\": \"111111\",\n \"expiring_system_id\": null,\n \"expiring_agent_id\": null\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": null,\n \"provider_timestamp\": null,\n \"transaction_id\": \"629d890a-d773-4615-9bc4-bbe12effcf94\"\n },\n \"system_timestamp\": \"2027-12-15 16:23:24\",\n \"rtoken\": \"e02c5a94-d6cc-4f54-a9ef-2058e61caac1\"\n}\n"}}},"application/xml":{"examples":{"response":{"value":"\n0\nSuccess\n0.082\n\n 999102163165\n N\n 2027-05-05\n 2027-04-04\n 1218.2\n 840\n \n Jack\n Abelard\n Smith\n 33 Maple Street\n #4b\n Salt Lake City\n UT\n 84121\n 840\n 8015556060\n 8012222222\n jasmith@emaildomain.com\n 1980-01-01\n \n 33 Business Parkway\n Suite 400\n Salt Lake City\n UT\n 84121\n 840\n \n 0\n Project Manager\n Kroger Food & Drug\n EN\n MDAxNgytmjkDU8vh9uxMG6ocw2kK\n 6fb41eb957374c06b066d80d022e776a\n \n 2\n 14\n \n \n \n 2027-10-01 00:00:00\n 2027-12-15 23:59:59\n 9\n \n 999102163165\n 43878\n SE\n 3424\n 2027-11-17 12:18:33\n -380\n Southern Car Rental, SALT LAKE CIT, US \n Mastercard Settlement\n 1421468\n 6439\n 6107\n 2027-11-17 12:08:12\n SE5\n \n \n 0\n M\n \n 840\n \n 840\n \n 840\n Y\n \n \n 999102163165\n 43871\n PM\n \n 2027-11-17 12:01:51\n 539.04\n Retail Load \n Payment\n 8893\n 6439\n 6107\n 2027-11-17 12:01:51\n PMRL\n \n f296950b-5089-42ca-a010-93b8c0652ed7\n 0\n ?\n \n \n \n \n \n \n \n \n \n 999102163165\n 41423\n FE\n \n 2027-10-21 09:24:04\n -2.5\n ATM Domestic Fee \n Fee\n 3611\n 6439\n 6107\n 2027-10-21 09:24:04\n FE0013\n \n \n 0\n ?\n \n \n \n \n \n \n \n \n \n 999102163165\n 41413\n VS\n 5411\n 2027-10-21 08:45:03\n -70\n 1-Retail, LT LAKE CITY, UTUS \n Visa settle\n 11452\n 6439\n 6107\n 2027-10-21 08:42:59\n VSA\n \n \n 0\n V\n \n \n \n \n \n \n Y\n \n \n 999102163165\n 41403\n VS\n 5411\n 2027-10-21 07:48:16\n -20\n 3-Mercado Las Americas, LT LAKE CITY, UTUS \n Visa settle\n 11447\n 6439\n 6107\n 2027-10-21 07:45:40\n VSA\n \n \n 0\n V\n \n \n \n \n \n \n Y\n \n \n 999102163165\n 41347\n SE\n 4121\n 2027-10-20 15:58:33\n 0\n Southern Rideshare, SALT LAKE CIT, US \n Mastercard Settlement\n 1411467\n 6439\n 6107\n 2027-10-20 15:53:10\n SE5\n \n \n 0\n M\n \n 840\n \n 840\n \n 840\n Y\n \n \n 999102163165\n 41237\n PM\n 4121\n 2027-10-19 11:10:47\n 100\n Mastercard Load \n Payment\n 8854\n 6439\n 6107\n 2027-10-19 11:10:47\n PMML\n \n \n 0\n ?\n \n \n \n \n \n \n \n \n \n 999102163165\n 40632\n VS\n 4776\n 2027-10-11 15:00:34\n -30\n Central Restaurant, , \n Visa settle\n 10702\n 6439\n 6107\n 2027-10-11 15:00:33\n VSM\n \n \n 0\n V\n \n \n \n \n \n \n Y\n \n \n 999102163165\n 40505\n AD\n \n 2027-10-10 10:37:07\n -355\n Adjustment \n Adjustment\n 11059\n 6439\n 6107\n 2027-10-10 10:37:07\n AD7\n \n 112233\n 0\n \n \n \n \n \n \n \n \n \n 3\n \n 11307\n Central Gasoline LT LAKE CITY UTUS \n CENTRAL GASOLINE, LT LAKE CITY, UT\n -75\n 2027-10-19 13:53:38\n L\n 5542\n KqS4Y5hJEVr9gqW\n 926253\n 99179444\n 1\n 0\n V\n 000000007500\n 840\n \n \n \n \n \n \n 11318\n Central RideshareLT LAKE CITY UTUS \n CENTRAL RIDESHARE, LT LAKE CITY, UT\n -66\n 2027-10-19 16:33:39\n L\n 4121\n eQCDZUUFnEn9Yx5\n 622996\n 17244583\n 1\n 11315\n V\n 000000001000\n 840\n \n \n \n \n \n \n 13854\n Central Car RentalLT LAKE CITY UTUS \n CENTRAL CAR RENTAL, LT LAKE CITY, UT\n -575\n 2027-11-17 11:52:57\n L\n 3424\n cfzgZ8kgmEA9mJm\n 947566\n 79853554\n 1\n 0\n V\n 000000050000\n 840\n \n \n \n \n \n \n 555555\n REP\n Replacement Card Fee\n 3\n 2027-11-13 00:00:00\n 33333\n \n \n \n \n 2027-10-01 00:00:00\n 2027-12-15 23:59:59\n 0\n 0\n 0\n \n \n \n false\n \n \n \n 4444\n 2027-11-15\n 2027-18-15\n 88888\n \n DE\n \n \n API\n qAe5Tg-0026\n 50\n 111111\n \n \n \n\n\n \n \n 629d890a-d773-4615-9bc4-bbe12effcf94\n\n2027-12-15 16:23:24\ne02c5a94-d6cc-4f54-a9ef-2058e61caac1\n"}}}},"description":""}},"parameters":[],"summary":"Get Account Overview","description":"Use the Get Account Overview endpoint to retrieve the combined response data from several other endpoints. Best practice is to use this endpoint to retrieve the data for a customer's landing page or other similar display.\n\nData sets returned by Get Account Overview:\n- General account information (balance, status, application date)\n- Cardholder profile data\n- Posted transactions\n- Pending card authorizations\n- Pending fees (generally because of insufficient funds)\n- Savings interest data, applicable only if an associated savings account exists; otherwise, a unary `savings_interest` element is returned.\n\n> 📘 Note\n> \n>Transactions created by Program API endpoints (such as Create Payment, Create Adjustment, and Create Account Transfer) are not present in this endpoint's response for several seconds after creation.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"startDate":{"type":"string","format":"date","nullable":true,"description":"The beginning date for the date range, either a date or a date-time.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"endDate":{"type":"string","format":"date","nullable":true,"description":"The end date for the date range, either a date or a date-time. Must be equal to or later than `startDate`. Max 1098 days (~3 years) after `startDate`. \nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Transactions"],"operationId":"post_getaccountoverview"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/createAccount":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"idType":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of identifier in `id`. This parameter is **required** when `id` is populated. See the **`idType`** column in the Customer ID Types table for valid values. When using the SoFi Tech Solutions <> integration, only `2` and `15` are valid.\nPattern: Integer\nExample: `2`","example":2},"id":{"type":"string","nullable":true,"description":"The value of the primary identifier that is specified in `idType`. This parameter is **required** when using the SoFi Tech Solutions <> integration. This value cannot be changed after the customer passes ID verification. All letters will be converted to lowercase.\nPattern: As specified in the **Layout for `id`** column of the Customer ID Types enumeration\nExample: `\"123456789\"`","example":"123456789"},"idType2":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of identifier in `id2`. This parameter is **required** when `id2` is populated. See the **`idType`** column in the Customer ID Types table for valid values.\nPattern: Integer\nExample: `1`","example":1},"id2":{"type":"string","nullable":true,"description":"The value of the identifier that is specified in `idType2`. This value can be changed but not nullified or cleared. All letters will be converted to lowercase. See Specifying a card design for non-<> uses of `id2`.\nPattern: As specified in the **Layout for `id`** column of the Customer ID Types enumeration\nExample: `\"123456789012|ut|12/25/2020\"`","example":"123456789012|ut|12/25/2020"},"idType3":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of identifier in `id3`. This parameter is **required** when `id3` is populated. See the **`idType`** column in the Customer ID Types table for valid values.\nPattern: Integer\nExample: `13`","example":13},"id3":{"type":"string","nullable":true,"description":"The value of the identifier that is specified in `idType3`. All letters will be converted to lowercase. This value can be changed but not nullified or cleared.\nPattern: As specified in the **Layout for `id`** column of the Customer ID Types enumeration\nExample: `\"abc123456789|05-22-2027\"`","example":"abc123456789|05-22-2027"},"locationType":{"type":"integer","format":"int32","default":0,"enum":[0,1,2,3],"nullable":true,"description":"Type of ID in `location`:\n* `0` — SoFi Tech Solutions location ID\n* `1` — Partner location ID\n* `2` — Don't validate\n* `3` — Instant-issue location override. Valid for Create Account only. See Setup for Instant Issue for details.\n\nPattern: Integer\nExample: `0`","example":0},"location":{"type":"string","nullable":true,"description":"Unique location identifier (`location`) as returned by the Create Location endpoint. This value is also returned by the Get Locations endpoint depending on the value of `locationType` when the location was created:\n* `0` or `2` — Returned in the `location_id` field\n* `1` — Returned in the `provider_specified_id` field\n\nPattern: Integer if `locationType: 0` or `locationType: 2`; max 15 characters if `locationType: 1`\nExample: `\"a455-3483\"`","example":"a455-3483"},"locale":{"type":"string","default":"en_US","enum":["en_US","es_US","en_CA","fr_CA","es_MX","en_MX"],"nullable":true,"description":"The account holder language and localization preference. Valid values are `en_US`, `es_US`, `fr_CA`, `en_CA`, `es_MX`, `en_MX`. If the account holder address is outside the U.S., pass a non `_US` value for this parameter to disable U.S. address validation.\nPattern: Letters with underscore\nExample: `\"en_US\"`","example":"en_US"},"externalAccountId":{"type":"string","nullable":true,"maximum":30,"pattern":"^[A-Za-z0-9\\-+/=_]*$","description":"User-supplied identifier that is related to an external system. This ID is stored in the system in association with this account and can be provided in the <>s.\nPattern: Max 30 alphanumeric characters. Lowercase only.\nExample: `\"553b45sbs\"`","example":"553b45sbs"},"firstName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's first name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Ed\"`","example":"Ed"},"middleName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's middle name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"W\"`","example":"W"},"lastName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's last name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Harley\"`","example":"Harley"},"dateOfBirth":{"type":"string","format":"date-time","nullable":true,"description":"Account holder's birth date. This date is compared with the DOB product parameter when there is a minimum age requirement on the account.\nPattern: YYYY-MM-DD\nExample: `\"1980-01-01\"`","example":"1980-01-01"},"address1":{"type":"string","nullable":true,"description":"Account holder's first address line. Cannot be a P.O. box. Validation rules for `address1`.\nPattern: 4–40 alphanumeric characters\nExample: `\"33 Maple Street\"`","example":"33 Maple Street"},"address2":{"type":"string","nullable":true,"description":"Account holder's second address line. \nPattern: Max 40 alphanumeric characters and address symbols\nExample: `\"#4B\"`","example":"#4B"},"address3":{"type":"string","nullable":true,"description":"Account holder's third address line. \nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Carrera Central\"`","example":"Carrera Central"},"address4":{"type":"string","nullable":true,"description":"Account holder's fourth address line.\nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Barrio El Alhambra\"`","example":"Barrio El Alhambra"},"address5":{"type":"string","nullable":true,"description":"Account holder's fifth address line. \nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Piso 3\"`","example":"Piso 3"},"city":{"type":"string","nullable":true,"description":"Account holder's city.\nPattern: Max 30 characters: letters, spaces, hyphen and period\nExample: `\"Salt Lake City\"`","example":"Salt Lake City"},"state":{"type":"string","nullable":true,"description":"Account holder's state or province. \nPattern: String\nExample: `\"UT\"`","example":"UT"},"postalCode":{"type":"string","nullable":true,"minimum":4,"maximum":10,"pattern":"^[a-zA-Z0-9\\-\\ ]*$","description":"Account holder's postal code (ZIP code).\nPattern: `1234`, `12345`, `12345-1234`, or `K1A-1A1`\nExample: `\"84121\"`","example":"84121"},"countryCode":{"type":"string","nullable":true,"pattern":"^\\d{3}$","description":"Account holder's country. Three-digit UN M49 code, such as `840` for USA, `124` for Canada, `484` for Mexico, `170` for Colombia.\nPattern: 3-digit number\nExample: `\"840\"`","example":"840"},"primaryPhone":{"type":"string","nullable":true,"pattern":"^([0-9]+)$","description":"Account holder's primary phone number. When passing a value for this parameter, you must also pass `mobilePhoneCountryCode`.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\n Example: `\"8015556060\"`","example":"8013656060"},"otherPhone":{"type":"string","nullable":true,"pattern":"^([0-9]+)$","description":"Account holder's secondary phone number. When passing a value for this parameter, you must also pass `mobilePhoneCountryCode`.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\n Example: `\"8015556060\"`","example":"8013656060"},"mobilePhone":{"type":"string","nullable":true,"pattern":"^([0-9]+)$","description":"Account holder's mobile phone number. When passing a value for this parameter, you must also pass `mobilePhoneCountryCode`.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\n Example: `\"8015556060\"`","example":"8013656060"},"mobileCarrierId":{"type":"string","nullable":true,"description":"Account holder's mobile carrier. Configurable list.\nPattern: Configurable list\nExample: `\"8\"`","example":"8"},"email":{"type":"string","nullable":true,"minLength":3,"maxLength":63,"pattern":"[A-Za-z0-9À-öø-þŒœŠšŸŽž!-@\\[-`{-~¡-¿÷€]+","description":"Account holder's email.\nPattern: Email address, 3–63 characters\nExample: `\"user@fakedomain.com\"`","example":"user@fakedomain.com"},"webUid":{"type":"string","nullable":true,"minimum":4,"maximum":30,"pattern":"^[a-zA-Z0-9]+(?:[_-][a-zA-Z0-9]+)*$","description":"Account holder's username for the website hosted by SoFi Tech Solutions. Must be unique across the program.\nPattern: Alphanumeric, with first character a letter; case insensitive\nExample: `\"eharley\"`","example":"eharley"},"webPwd":{"type":"string","nullable":true,"description":"Account holder's password for the website hosted by SoFi Tech Solutions.\nPattern: Min 8 characters: must include upper-case character, lower-case character, and a number\nExample: `\"4j9KH3kkdh\"`","example":"4j9KH3kkdh"},"secretQuestion":{"type":"string","nullable":true,"maximum":50,"pattern":"^[\\w\\s\\?\\']*$","description":"Account holder's secret question for the website hosted by SoFi Tech Solutions.\nPattern: Max 50 characters: letters, spaces, `?`\nExample: `\"What was the name of your first pet?\"`","example":"What was the name of your first pet?"},"secretAnswer":{"type":"string","nullable":true,"maximum":50,"description":"Account holder's answer to `secretQuestion`.\nPattern: Max 50 characters: letters, spaces, `?`\nExample: `\"Larry\"`","example":"Larry"},"incomeSource":{"type":"string","nullable":true,"minimum":2,"maximum":60,"pattern":"^[a-zA-Z0-9\\|_\\-@\\.,' &]*$","description":"Account holder's employer name or income source.\nPattern: Max 60 characters: alphanumeric, space, underscore, hyphen, period, `@`, `&` and comma.\nExample: `\"Kroger Food & Drug\"`","example":"Kroger Food & Drug"},"occupation":{"type":"string","nullable":true,"minimum":2,"maximum":60,"pattern":"^[a-zA-Z0-9\\|_\\-@\\.,' &]*$","description":"Account holder's occupation.\nPattern: Max 60 characters: alphanumeric, space, underscore, hyphen, period, `@`, `&` and comma.\nExample: `\"Project Manager\"`","example":"Project Manager"},"nationality":{"type":"string","nullable":true,"maxLength":2,"description":"Account holder's nationality.\nPattern: 2-character ISO-3166-2 code\n:Example: `\"MX\"`","example":"MX"},"placeOfBirth":{"type":"string","nullable":true,"maxLength":6,"description":"Account holder's place of birth\nPattern: ISO-3166-2 subdivision code\nExample: MX-YUC","example":"MX-YUC"},"curp":{"type":"string","nullable":true,"maxLength":18,"description":"Account holder's <>\nPattern: 18 alphanumeric characters\nExample: `\"HRGRAL82050602H900\"`","example":"HRGRAL82050602H900"},"politicalAffiliation":{"type":"integer","format":"int32","nullable":true,"minimum":0,"maximum":1,"description":"Whether the account holder is a <>.\n- `1` — PEP\n- `0` — Not a PEP.\n","example":"1"},"kycRefNo":{"type":"string","nullable":true,"maxLength":36,"description":"<> reference number to track the KYC process for the account holder.\nPattern: 36 characters\nExample: `\"KYC123456789012312312312521312312312\"` ","example":"KYC123456789012312312312521312312312"},"monthlyIncome":{"type":"number","format":"float","nullable":true,"minimum":0,"maximum":9999999999,"description":"Monthly income for the account holder.\nPattern: Float between 0 and 9999999999\nExample: `3400.00`","example":"3400.00"},"externalCustomerId":{"type":"string","nullable":true,"maximum":512,"description":"User-supplied identifier that is related to an external system.\nPattern: Max 512 characters: all ASCII characters\nExample: `\"acv#-@45!sbsxm%-\"`","example":"acv#-@45!sbsxm%-"},"prodId":{"type":"integer","format":"int32","minimum":0,"maximum":100000000,"description":"A unique product identifier from SoFi Tech Solutions. If this ID is for a business product then `businessName` is **required**.\nPattern: Integer\nExample: `501`","example":501},"loadAmount":{"type":"number","format":"float","nullable":true,"minimum":0,"description":"Currency amount passed as a whole or decimal amount. Initial load amount on a card must be within product load limits or be the designated amount for an instant-issue card.\nPattern: Float or integer\nExample: `100.00`, `100` or `100.73`","example":100.73},"loadType":{"type":"string","nullable":true,"maximum":2,"pattern":"^[a-zA-Z0-9]*$","description":"Transaction type for the `loadAmount`. Use values from your list of load types from SoFi Tech Solutions. If no `loadType` is specified, the default type `RL` (retail load) is used.\nPattern: String\nExample: `\"RL\"`","example":"RL"},"primaryAccount":{"type":"string","nullable":true,"pattern":"^[0-9]{12}$|^[0-9]{16}$","description":"<> or <> of the primary account to associate this account with. Populate this parameter only when creating a secondary account.\nPattern: PAN or PRN\nExample: `\"123456789012\"`","example":"123456789012"},"fundingAccountNo":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12})$","description":"PRN of the <> funding account. **Required** if `prodId` is an RTF spending product.\nPattern: 12-digit numeric string\nExample: `\"143101204201\"`","example":"143101204201"},"sharedBalance":{"type":"integer","format":"int32","enum":[0,1],"nullable":true,"description":"Specifies whether the secondary account will share the balance of the primary account. This parameter is **required** when `primaryAccount` is populated. Do not set this parameter to `1` when `primaryAccount` is not populated.\n* `0` — Do not share the balance\n* `1` — Share the balance\n\nPattern: Integer\nExample: `1`","example":1},"authorizedUser":{"type":"integer","format":"int32","enum":[0,1],"nullable":true,"description":"Specifies whether the account is an authorized user. This parameter requires `primaryAccount` and `sharedBalance` to be populated.\n* `0` — Do not mark this account as authorized user\n* `1` — Mark this account as authorized user\n\nPattern: Integer\nExample: `1`","example":1},"userData":{"type":"string","nullable":true,"maximum":50,"pattern":"^[a-zA-Z0-9_ ]*$","description":"Data supplied by the provider, from sources external to the system. This data will be stored in the system in association with this account. The most common use of this parameter is to track affiliate-marketing traffic. The data in this field can be added to an <>.\nPattern: Supported characters\nExample: `\"a4434gg44\"`","example":"a4434gg44"},"offline":{"type":"integer","format":"int32","enum":[0,1],"nullable":true,"description":"Pass `1` for an offline transaction. \nPattern: Integer\nExample: `0`","example":0},"verifyOnly":{"type":"integer","format":"int32","enum":[0,1],"nullable":true,"description":"Pass `1` to test the validity of the parameter data without committing the information to the system.\nPattern: Integer\nExample: `0`","example":0},"cipStatus":{"type":"string","enum":["0","1","2"],"nullable":true,"description":"_Legacy CIP only_. CIP setting override.\n* `\"0\"` or empty — Do not override the Legacy CIP setting.\n* `\"1\"` — Create the customer record and run Legacy CIP but do not create an account.\n* `\"2\"` — Create the customer record and account but do not run Legacy CIP.\n\nPattern: Numeric string\nExample: `\"0\"`","example":"0"},"embossLine2":{"type":"string","nullable":true,"maximum":28,"pattern":"^[a-zA-Z0-9_\\s\\'\"!\\?\\-]*$","description":"Second line to emboss on the card.\nPattern: Supported characters\nExample: `\"Scarlet Ibis Shipping\"`","example":"Scarlet Ibis Shipping"},"providerAssessedFee":{"type":"number","format":"float","nullable":true,"minimum":-0.001,"maximum":999999999999.99,"description":"Fee amount assessed by the provider. This value is passed to SoFi Tech Solutions only for informational purposes: passing this parameter does not assess the fee.\nPattern: Monetary amount greater than 0.\nExample: `2.50`","example":2.5},"loadFromAccountNo":{"type":"string","nullable":true,"pattern":"^[0-9]{12}$|^[0-9]{16}$","description":"To load funds into the account at the time of account creation, specify the <> or <> of the source account for the funds. This account must be in the same program as the account being created.\nPattern: PAN or PRN\nExample: `\"123456789012\"`","example":"123456789012"},"sweepDate":{"type":"string","format":"date-time","nullable":true,"description":"The last date that a daily sweep should be performed. This parameter is valid only if account sweeping is configured for the product.\nPattern: YYYY-MM-DD\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"expressMail":{"type":"string","enum":["0","1","2","3","4","5","6","7","8","9","Y","N"],"nullable":true,"description":"The type of shipping for the physical card associated with this account. These values are universal across all vendors:\n- `1` — Standard shipping\n- `2` — Express shipping\n- `4` — Bulk shipping\n\nLegacy values `Y` = `2` and `N` = `1`. Consult your emboss vendor for other values.\nPattern: String\nExample: `\"2\"`","example":"2"},"shipToAddressPermanent":{"type":"string","nullable":true,"pattern":"^(1|0)$","description":"Pass `1` to always ship cards to the ship-to address instead of one time only.\nPattern: `1` or `0`\nExample: `\"1\"`","example":"1"},"shipToAddress1":{"type":"string","nullable":true,"description":"First ship-to address line.\nPattern: Max 40 characters\nExample: `\"33 business parkway\"`","example":"33 business parkway"},"shipToAddress2":{"type":"string","nullable":true,"maximum":40,"description":"Second ship-to address line.\nPattern: Max 40 characters\nExample: `\"Suite 400\"`","example":"Suite 400"},"shipToCity":{"type":"string","nullable":true,"description":"Ship-to city.\nPattern: Max 30 characters\nExample: `\"Salt Lake City\"`","example":"Salt Lake City"},"shipToState":{"type":"string","nullable":true,"description":"Ship-to state. \nPattern: String\nExample: `\"UT\"`","example":"UT"},"shipToPostalCode":{"type":"string","nullable":true,"minimum":4,"maximum":10,"pattern":"^[a-zA-Z0-9\\-\\ ]*$","description":"Ship-to ZIP or postal code.\nPattern: `1234`, `12345`, `12345-1234`, `K1A-1A1`\nExample: `\"841213333\"`","example":"841213333"},"shipToCountryCode":{"type":"string","nullable":true,"pattern":"^[0-9]{3}$","description":"Ship-to country. Three-digit UN M49 country code, such as `840` for USA, `124` for Canada, `484` for Mexico, `170` for Colombia.\nPattern: 3-digit number\nExample: `\"840\"`","example":"840"},"businessName":{"type":"string","nullable":true,"description":"Account holder's business name. This field is **required** if `prodId` is a business product.\nPattern: 2–150 characters. See the supported character set.\nExample: `\"Ed%26Ted\"`","example":"Ed","pattern":"^[A-Za-z0-9_\\s\\'-\\.,\\?@&\\!#~\\*;\\+ '-]*$"},"mobilePhoneCountryCode":{"type":"string","nullable":true,"minimum":2,"maximum":4,"pattern":"^\\+[0-9]*$","description":"Account holder's mobile phone country code.\nPattern: A plus sign followed by 1–3 digits. See Phone Validation for valid values. \nExample: `\"+1\"`","example":"+1"},"riskContextId":{"type":"string","nullable":true,"description":"A session-correlation token from the front-end risk signal collection to link to account-risk decisioning.\n Pattern: String\nExample: `\"300dcfeesarEEd\"`"}},"required":["prodId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Create Account","description":"Use the Create Account endpoint to create an account for a new customer. You can use this endpoint for personalized, instant issue, and secondary products.\n\nThis endpoint can run customer ID verification (<>) if the EIVS provider parameter is set. (This endpoint also runs legacy CIP verification and returns the appropriate fields.) Create Account creates a customer record and at the same time creates an account. Depending on product settings, it also creates a card and loads funds onto it. \n\nConsult the Creating an Account guide for instructions on using this endpoint, and consult the Customer ID Verification guide for how to use this endpoint with IVS. The instructions have flowcharts to illustrate how Create Account works in the system. Also see Create Account vs Add Account in the _About Accounts_ guide.\n\n > 📘 Note\n> \n> You can receive unmasked PCI-sensitive data (`card_number`, `card_security_code`, `expiry_date`) only if your provider parameters permit it.\n\n #### Duplicate use of customer ID\nSoFi Tech Solutions can configure your product parameters to allow or disallow the duplicate use of customer IDs such as SSNs across your programs.\n\n#### Required fields\nMost input parameters for this endpoint are not required, to accommodate various use cases. If you would like some of the parameters to be required, populate the PINED product parameter with the parameters to be required. For example: `idType,id,idType2,id2`. \n\nIf this endpoint returns a status code that does not match a status code that is specific to this endpoint, it might be an enrollment status code. See Enrollment Statuses for more information.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"xid":{"type":"string","description":"_Internal providers only_. System-generated internal identifier for the account. Has a 1:1 relationship with the PRN."},"pmt_ref_no":{"type":"string","description":"System-generated account number (<>)."},"product_id":{"type":"string","description":"Identifier for the product associated with the account"},"galileo_account_number":{"type":"string","description":"System-generated balance ID"},"cip":{"type":"array","nullable":true,"description":"List of customer ID verification objects, either <> or Legacy CIP, as indicated.","items":{"type":"object","properties":{"status":{"type":"string","description":"Status of the <> verification: `Pass`, `Fail`, `Refer`, `In Progress`."},"model_results":{"type":"array","nullable":true,"description":"_Legacy CIP only_. List of model objects.","items":{"type":"object","properties":{"model_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. The model name"},"model_version":{"type":"integer","format":"int32","nullable":true,"description":"_Legacy CIP only_. Version number for the model used"},"code":{"type":"string","nullable":true,"description":"_Legacy CIP only_. In a model run, lists the pass number"},"text":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Plaintext description of the code value"}},"required":["code","model_name","model_version","text"]}},"date_time":{"type":"string","format":"date-time","nullable":true,"description":"_Legacy CIP only_. Timestamp for when CIP was run."},"first_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's first name"},"middle_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's middle name"},"last_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's last name"},"address_1":{"type":"string","nullable":true,"description":"_Legacy CIP only_. First line of the account holder's address"},"address_2":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Second line of the account holder's address"},"city":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's city"},"state":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's state"},"primary_phone":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's primary phone number"},"other_phone":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's other phone number"},"entity_id":{"type":"string","description":"_IVS only_. System-generated ID for the entity. Currently contains the app ID. "},"customer_id":{"type":"string","description":"_IVS only_. System-generated ID for the customer undergoing verification. Currently contains the app ID. "}},"required":["status"]}},"card_id":{"type":"string","nullable":true,"description":"System-generated <>. Use this ID instead of the <> if not PCI-compliant. `None` means that no card was created."},"new_emboss_uuid":{"type":"string","nullable":true,"description":"UUID for an emboss record that has not yet been sent to the embosser."},"card_number":{"type":"string","nullable":true,"description":"The primary account number (PAN) printed on the card"},"expiry_date":{"type":"string","format":"date","nullable":true,"description":"YYYY-MM-DD. The card expires on the last day of the month (MM). Ignore the day (DD)."},"card_security_code":{"type":"string","nullable":true,"description":"The card verification value (CVV2)"},"emboss_line_2":{"type":"string","nullable":true,"description":"Second line to emboss on the card"},"billing_cycle_day":{"type":"integer","format":"int32","nullable":true,"description":"The day of the month the billing cycle starts for the account"}},"required":["billing_cycle_day","card_number","card_security_code","cip","emboss_line_2","expiry_date","galileo_account_number","pmt_ref_no","product_id"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 2.847,\n \"response_data\": [\n {\n \"pmt_ref_no\": \"999654321098\",\n \"product_id\": \"1701\",\n \"galileo_account_number\": \"22222\",\n \"cip\": [\n {\n \"status\": \"Pass\",\n \"entity_id\": \"1307398\",\n \"customer_id\": \"1307398\"\n }\n ],\n \"card_id\": \"44444\",\n \"card_number\": \"999911XXXXXX1234\",\n \"expiry_date\": \"2029-03-09\",\n \"card_security_code\": \"123\",\n \"emboss_line_2\": null,\n \"billing_cycle_day\": 15,\n \"new_emboss_uuid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n }\n ],\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"ca36095d-096e-43db-a6d6-90571a7fe2dd\"\n },\n \"system_timestamp\": \"2026-06-09 16:41:13\",\n \"rtoken\": \"daaf9789-1654-4313-9355-4e29b2ecf16d\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 2.847\n \n \n 999654321098\n 1701\n 22222\n \n \n Pass\n 1307398\n 1307398\n \n \n 44444\n 999911XXXXXX1234\n 2029-03-09\n 123\n \n 15\n a1b2c3d4-e5f6-7890-abcd-ef1234567890\n \n \n \n \n \n ca36095d-096e-43db-a6d6-90571a7fe2dd\n \n 2026-06-09 16:41:13\n daaf9789-1654-4313-9355-4e29b2ecf16d\n"}}}},"description":""}},"operationId":"post_createaccount"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getAccountCards":{"post":{"summary":"Get Account Cards","description":"Use the Get Account Cards endpoint to retrieve a customer's profile information along with all accounts and cards that are associated with that customer, regardless of status.\n\n[block:callout]\n\n{\n\"type\": \"info\",\n\"title\": \"Note\",\n\"body\": \"You can receive PCI-sensitive information only if your provider parameters permit it.\"\n}\n[/block]\n\n","parameters":[],"tags":["Accounts and Cards"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"includeRelated":{"type":"integer","format":"int32","default":1,"enum":[0,1],"description":"Whether to return data for all accounts that share the same cardholder (`client_id`).\n- `0` — Retrieve only the cards for the specified account.\n- `1` or _blank_ — Retrieve all accounts and cards that share the same `client_id`.\n\nPattern: Integer\nExample: `0`","example":0}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"customer":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"description":"The first name on the customer profile"},"middle_name":{"type":"string","nullable":true,"description":"The middle name on the profile"},"last_name":{"type":"string","nullable":true,"description":"The last name on the profile"},"address_1":{"type":"string","nullable":true,"description":"First line of the customer address"},"address_2":{"type":"string","nullable":true,"description":"Second line of the customer address"},"city":{"type":"string","nullable":true,"description":"City of the address"},"state":{"type":"string","nullable":true,"description":"State of the address"},"postal_code":{"type":"string","nullable":true,"description":"Postal code of the address"},"country_code":{"type":"string","nullable":true,"description":"ISO 3166 numeric country code"},"phone":{"type":"string","nullable":true,"description":"The home phone number"},"mobile_phone":{"type":"string","nullable":true,"description":"The mobile phone number on a profile"},"mobile_phone_country_code":{"type":"string","nullable":true,"description":"The country code for all phone numbers"},"email":{"type":"string","nullable":true,"description":"The email address on a profile"},"ship_to_address":{"type":"object","properties":{"address_1":{"type":"string","nullable":true,"description":"First line of the ship-to address where to mail the card"},"address_2":{"type":"string","nullable":true,"description":"Second line of the address."},"city":{"type":"string","nullable":true,"description":"City of the ship-to address"},"state":{"type":"string","nullable":true,"description":"State of the ship-to address"},"postal_code":{"type":"string","nullable":true,"description":"Postal code of the ship-to address"},"country_code":{"type":"string","nullable":true,"description":"ISO 3166 numeric country code of the ship-to address"}},"required":["address_1","address_2","city","country_code","postal_code","state"]},"express_mail":{"type":"string","nullable":true,"description":"Whether the profile uses express-mail service"},"occupation":{"type":"string","nullable":true,"description":"The occupation of the person in the profile"},"income_source":{"type":"string","nullable":true,"description":"How the person on a profile earns income"},"related_accounts":{"type":"array","description":"List of related accounts","items":{"nullable":true,"type":"object","properties":{"active":{"type":"string","description":"Whether the account is active: `Y` or `N`"},"application_date":{"type":"string","format":"date","nullable":true,"description":"The date of the application for account creation (YYYY-MM-DD)."},"bill_cycle_day":{"type":"string","nullable":true,"description":"Day of the month that the customer is billed"},"galileo_account_number":{"type":"string","nullable":true,"description":"System-generated account number, also known as balance ID"},"group_id":{"type":"string","nullable":true,"description":"Integer value used for tracking the location (store, entity, etc.) where the customer was acquired"},"pmt_ref_no":{"type":"string","nullable":true,"description":"Payment reference number (PRN), a 12-digit system-generated account number"},"product_id":{"type":"string","nullable":true,"description":"A unique product identifier from SoFi Tech Solutions"},"start_date":{"type":"string","format":"date","nullable":true,"description":"Date the account was first activated (`status: N`) (YYYY-MM-DD)"},"status":{"type":"string","nullable":true,"description":"The status of the account. See Account Statuses for valid values."}},"required":["active","application_date","bill_cycle_day","galileo_account_number","group_id","pmt_ref_no","product_id","start_date","status"]}},"preferred_name":{"type":"string","nullable":true,"description":"The preferred name on a profile, to appear on cards and CST profiles. The preferred name feature is currently in development. Additional configuration is required. Contact SoFi Tech Solutions if you are interested in this feature."}},"required":["address_1","address_2","city","country_code","express_mail","first_name","income_source","last_name","middle_name","mobile_phone","occupation","phone","postal_code","related_accounts","ship_to_address","state"]},"accounts":{"type":"array","description":"List of accounts","items":{"nullable":true,"type":"object","properties":{"active":{"type":"string","description":"Whether the account is active: `Y` or `N`"},"application_date":{"type":"string","format":"date","nullable":true,"description":"The date of the application for account creation (YYYY-MM-DD)."},"bill_cycle_day":{"type":"string","nullable":true,"description":"Day of the month that the customer is billed"},"galileo_account_number":{"type":"string","nullable":true,"description":"System-generated account number, also known as the balance ID"},"group_id":{"type":"string","nullable":true,"description":"Integer value used for tracking the location (store, entity, etc.) where the customer was acquired"},"pmt_ref_no":{"type":"string","nullable":true,"description":"Payment reference number (PRN). A 12-digit system-generated account number"},"product_id":{"type":"string","nullable":true,"description":"A unique product identifier from SoFi Tech Solutions"},"start_date":{"type":"string","format":"date","nullable":true,"description":"Date the account was first activated (`status: N`) (YYYY-MM-DD). "},"status":{"type":"string","nullable":true,"description":"The status of the account. See Account Statuses for valid values."},"cards":{"type":"array","description":"List of cards associated with the PRN","items":{"type":"object","properties":{"card_id":{"type":"string","nullable":true,"description":"Also called the CAD, a system-generated identifier for a card"},"card_number":{"type":"string","description":"A 16-digit PAN. Set CINFI when PCI-compliant to see the unmasked PAN."},"emboss_uuid":{"type":"string","nullable":true,"description":"UUID for an emboss record that has been sent to the embosser. When this field is present outside the `embossed_cards` object, it contains the most recent emboss UUID."},"card_status":{"type":"string","description":"A single-letter code for the status of the card. See Card Statuses for valid values."},"expiry_date":{"type":"string","format":"date-time","nullable":true,"description":"_Supported data types: date, datetime, null, empty string._ Expiration date of the card (YYYY-MM-DD). (The card expires on the last day of the month [MM], not on the day [DD].) Set CINFD when PCI-compliant to see this value. Set CXPTM to include the time (YYYY-MM-DD hh:mm:ss)."},"external_card_id":{"type":"string","nullable":true,"description":"User-specified external card identifier"},"pin_fail_count":{"type":"string","nullable":true,"description":"The number of failed-PIN attempts in the counter"},"pin_fail_date":{"type":"string","format":"date-time","nullable":true,"description":"Date of the last failed PIN attempt"},"freeze_info":{"type":"object","properties":{"status":{"type":"string","description":"Whether the card is `Frozen` or `Unfrozen`."},"start_date":{"type":"string","format":"date-time","nullable":true,"description":"Start date-time for the card freeze."},"end_date":{"type":"string","format":"date-time","nullable":true,"description":"End date-time for the card freeze."}},"required":["end_date","start_date","status"]},"embossed_cards":{"type":"array","nullable":true,"description":"List of emboss records, one for each time the card was sent to the embosser. This object is populated only when emboss records exist.","items":{"nullable":true,"type":"object","properties":{"created_date":{"type":"string","format":"date-time","nullable":true,"description":"_Supported data types: date, datetime, null, empty string._ The date the card was created in the system (YYYY-MM-DD). Set CXPTM to include the time (YYYY-MM-DD hh:mm:ss)."},"emboss_uuid":{"type":"string","nullable":true,"description":"UUID for an emboss record that has been sent to the embosser. When this field is present outside the `embossed_cards` object, it contains the most recent emboss UUID."},"emboss_date":{"type":"string","format":"date","nullable":true,"description":"The date the card was sent to the embosser (YYYY-MM-DD)"},"expiry_date":{"type":"string","format":"date-time","nullable":true,"description":"_Supported data types: date, datetime, null, empty string._ Expiration date of the card (YYYY-MM-DD). (The card expires on the last day of the month [MM], not on the day [DD].) Set CINFD when PCI-compliant to see this value. Set CXPTM to include the time (YYYY-MM-DD hh:mm:ss)."},"product_id":{"type":"string","nullable":true,"description":"Product ID of card at the time of embossing"},"status":{"type":"string","nullable":true,"description":"Emboss status. For valid values see the Emboss Statuses enumeration."},"shipping_type":{"type":"string","nullable":true,"description":"The shipping type used to send the card to the cardholder: `standard` or `express`"},"emboss_name":{"type":"string","nullable":true,"description":"The cardholder name embossed on the card, from the emboss record."}},"required":["created_date","emboss_date","emboss_name","emboss_uuid","expiry_date","product_id","shipping_type","status"]}},"card_format":{"type":"string","nullable":true,"description":"Whether the card is `Physical` or `Virtual`."},"card_type":{"type":"string","nullable":true,"description":"Whether the card account is `Credit` or `Debit`."},"activation_date":{"type":"string","nullable":true,"description":"Date and time the card was activated (YYYY-MM-DD HH:MM:SS). Null if the card has not yet been activated."}},"required":["card_id","card_number","card_status","emboss_uuid","embossed_cards","expiry_date","external_card_id","freeze_info","pin_fail_count","pin_fail_date"]}}},"required":["active","application_date","bill_cycle_day","cards","galileo_account_number","group_id","pmt_ref_no","product_id","start_date","status"]}}},"required":["accounts","customer"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.129,\n \"response_data\": {\n \"customer\": {\n \"first_name\": \"Desiderius\",\n \"middle_name\": \"\",\n \"last_name\": \"Erasmus\",\n \"address_1\": \"565 Verdant St\",\n \"address_2\": \"\",\n \"city\": \"Greenburg\",\n \"state\": \"UT\",\n \"postal_code\": \"84333\",\n \"country_code\": \"840\",\n \"phone\": null,\n \"mobile_phone\": \"8015553467\",\n \"mobile_phone_country_code\": \"1\",\n \"email\": \"derasmus@prodigy.com\",\n \"ship_to_address\": {\n \"address_1\": \"PO Box 444\",\n \"address_2\": null,\n \"city\": \"Greenburg\",\n \"state\": \"UT\",\n \"postal_code\": \"84333\",\n \"country_code\": \"840\"\n },\n \"express_mail\": \"N\",\n \"related_accounts\": [\n {\n \"pmt_ref_no\": \"777777777777\",\n \"galileo_account_number\": \"8369\",\n \"product_id\": \"3333\",\n \"active\": \"Y\",\n \"status\": \"N\",\n \"group_id\": null,\n \"application_date\": \"2027-01-25\",\n \"start_date\": \"2027-01-25\",\n \"bill_cycle_day\": null\n }\n ],\n \"occupation\": null,\n \"income_source\": null\n },\n \"accounts\": [\n {\n \"active\": \"Y\",\n \"application_date\": \"2027-01-25\",\n \"bill_cycle_day\": \"25\",\n \"galileo_account_number\": \"8369\",\n \"group_id\": null,\n \"pmt_ref_no\": \"777777777777\",\n \"product_id\": \"3333\",\n \"start_date\": \"2027-01-25\",\n \"status\": \"N\",\n \"cards\": []\n },\n {\n \"active\": \"Y\",\n \"application_date\": \"2027-01-25\",\n \"bill_cycle_day\": \"25\",\n \"galileo_account_number\": \"8368\",\n \"group_id\": null,\n \"pmt_ref_no\": \"888888888888\",\n \"product_id\": \"2222\",\n \"start_date\": \"2027-01-25\",\n \"status\": \"N\",\n \"cards\": [\n {\n \"card_id\": \"4444\",\n \"card_number\": \"525691XXXXXX6388\",\n \"emboss_uuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"card_status\": \"N\",\n \"expiry_date\": \"2026-12-04\",\n \"external_card_id\": null,\n \"pin_fail_count\": \"0\",\n \"pin_fail_date\": null,\n \"freeze_info\": {\n \"status\": \"Unfrozen\",\n \"start_date\": null,\n \"end_date\": null\n },\n \"embossed_cards\": [\n {\n \"created_date\": \"2027-06-04\",\n \"emboss_uuid\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"emboss_date\": \"2027-06-04\",\n \"expiry_date\": \"2026-12-04\",\n \"status\": \"N\",\n \"shipping_type\": \"standard\",\n \"product_id\": \"3333\"\n },\n {\n \"created_date\": \"2027-01-25\",\n \"emboss_uuid\": \"543e21a1-e89b-12d3-a456-426614174999\",\n \"emboss_date\": \"2027-01-25\",\n \"expiry_date\": \"2027-07-25\",\n \"status\": \"N\",\n \"shipping_type\": \"standard\",\n \"product_id\": \"3333\"\n }\n ]\n },\n {\n \"card_id\": \"5555\",\n \"card_number\": \"525691XXXXXX4022\",\n \"emboss_uuid\": \"a453e99a-e89b-12d3-a456-426614175333\",\n \"card_status\": \"N\",\n \"expiry_date\": \"2026-03-03\",\n \"external_card_id\": null,\n \"pin_fail_count\": \"0\",\n \"pin_fail_date\": null,\n \"freeze_info\": {\n \"status\": \"Unfrozen\",\n \"start_date\": null,\n \"end_date\": null\n },\n \"embossed_cards\": [\n {\n \"created_date\": \"2027-11-03\",\n \"emboss_uuid\": \"a453e99a-e89b-12d3-a456-426614175333\",\n \"emboss_date\": \"2027-11-03\",\n \"expiry_date\": \"2026-03-03\",\n \"status\": \"Y\",\n \"shipping_type\": \"standard\",\n \"product_id\": \"2222\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"ab33a561-6773-4d7e-80a4-b4d4fcce972c\"\n },\n \"system_timestamp\": \"2027-11-03 12:34:20\",\n \"rtoken\": \"14d2abea-ab32-4cc3-88e1-ebfc04bf6257\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n \n 0\n Success\n 0.129\n \n \n Desiderius\n \n Erasmus\n 565 Verdant St\n \n Greenburg\n UT\n 84333\n 840\n \n 8015553467\n 1\n derasmus@prodigy.com\n \n PO Box 444\n \n Greenburg\n UT\n 83033\n 840\n \n N\n \n 777777777777\n 8369\n 3333\n Y\n N\n \n 2027-01-25\n 2027-01-25\n \n \n \n \n \n \n Y\n 2027-01-25\n 25\n 8369\n \n 777777777777\n 3333\n 2027-01-25\n N\n \n \n Y\n 2027-01-25\n 25\n 8368\n \n 888888888888\n 2222\n 2027-01-25\n N\n \n 4444\n 525691XXXXXX6388\n 123e4567-e89b-12d3-a456-426614174000\n N\n 2026-12-04\n \n 0\n \n \n Unfrozen\n \n \n \n \n 2027-06-04\n 123e4567-e89b-12d3-a456-426614174000\n 2027-06-04\n 2026-12-04\n N\n standard\n 3333\n \n \n 2027-01-25\n 543e21a1-e89b-12d3-a456-426614174999\n 2027-01-25\n 2027-07-25\n N\n standard\n 3333\n \n \n \n 5555\n 525691XXXXXX4022\n a453e99a-e89b-12d3-a456-426614175333\n N\n 2026-03-03\n \n 0\n \n \n Unfrozen\n \n \n \n \n 2027-11-03\n a453e99a-e89b-12d3-a456-426614175333\n 2027-11-03\n 2026-03-03\n Y\n standard\n 2222\n \n \n \n \n \n \n \n ab33a561-6773-4d7e-80a4-b4d4fcce972c\n \n 2027-11-03 12:34:20\n 14d2abea-ab32-4cc3-88e1-ebfc04bf6257\n \n"}}}},"description":""}},"operationId":"post_getaccountcards"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/modifyStatus":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <>, <> or <> of the account.\nPattern: PAN, PRN, or CAD\nExample: `\"074103447228\"`","example":"074103447228"},"type":{"type":"integer","format":"int32","description":"Specifies the account and/or card status to set. See the Modify Status Types enumeration for valid values.\nPattern: Predefined integer value range\nExample: `2`","example":2},"startDate":{"type":"string","format":"date-time","nullable":true,"description":"Valid only with `type: 17` (freeze card). If you pass a value for `startDate`, you must also populate `endDate`. Default is current date-time.\nPattern: `YYYY-MM-DD hh:mm:ss`\nExample: `\"2020-02-02 12:22:02\"`","example":"2020-02-02 12:22:02"},"endDate":{"type":"string","format":"date-time","nullable":true,"description":"Valid only with `type: 17` (freeze card). If you pass a value for `endDate`, you must also populate `startDate`. Must be later than `startDate`. Default is current date-time plus 24 hours.\nPattern: `YYYY-MM-DD hh:mm:ss`\nExample: `\"2020-02-12 10:00:00\"`","example":"2020-02-12 10:00:00"},"bypassRepFee":{"type":"string","enum":["Y","N"],"nullable":true,"description":"Valid only when `type: 19`. Pass `Y` to bypass the card replacement fee (REP).\nPattern: String\nExample: `\"Y\"`","example":"Y"},"cardNumberLastFour":{"type":"string","nullable":true,"pattern":"[0-9]{4}$","description":"If multiple cards are associated with this account, use this value to ensure that the correct card is selected.\nPattern: 4 digits\nExample: `\"0789\"`","example":"0789"},"closureReason":{"type":"string","enum":["inactivity","paid_user","chargeoff","collection","deleted_fraud","external_application_fraud_first_party_synthetic_id","external_application_fraud_first_party_income_misrepresentation","external_application_fraud_first_party_employment_misrepresentation","external_application_fraud_first_party_other_misrepresentation","external_credit_fraud_first_party_loan_stacking","external_credit_fraud_first_party_forced_post_transaction","external_credit_fraud_first_party_bustout","external_credit_fraud_first_party_other","external_mule_fraud_first_party_witting_mule","external_mule_fraud_first_party_unwitting_mule","external_profile_level_application_fraud_third_party_id_theft_existing_member","external_profile_level_application_fraud_third_party_id_theft_unknown_entity","external_account_takeover_fraud_third_party_social_engineering_phishing","external_account_takeover_fraud_third_party_compromised_credentials","external_account_takeover_fraud_third_party_sim_swap","external_account_takeover_fraud_third_party_password_profile_recovery_exploits","external_account_takeover_fraud_third_party_other_account_takeover","external_account_unauthorized_transaction_third_party_family_friendly_fraud","external_account_unauthorized_transaction_third_party_elder_abuse_financial_exploitation","external_account_unauthorized_transaction_third_party_unemployment_benefit_fraud","external_account_unauthorized_transaction_third_party_compromised_account_number","external_account_unauthorized_transaction_third_party_other","external_account_unauthorized_transaction_third_party_compromised_card_number","external_account_unauthorized_transaction_third_party_lost_stolen","external_account_authorized_transaction_third_party_scam_charity","external_account_authorized_transaction_third_party_scam_investment","external_account_authorized_transaction_third_party_scam_goods_services","external_account_authorized_transaction_third_party_scam_jobs","external_account_authorized_transaction_third_party_scam_property_real_estate","external_account_authorized_transaction_third_party_scam_romance","external_account_authorized_transaction_third_party_scam_known_family_friend","external_account_authorized_transaction_third_party_scam_other","internal_asset_misappropriation_fraud","internal_theft_fraud_access_abuse","internal_member_information_abuse_theft","internal_insider_insider_collusion","internal_insider_outsider_collusion","paid_chargeoff","paid_collection","deleted_no_fraud","deceased"],"nullable":true,"description":"Specifies the account closure reason. See the Account Closure Reasons enumeration for valid values. Populate this parameter only when `type` contains `2`, `13`, `16` or `20`.\nPattern: String\nExample: `\"inactivity\"`","example":"inactivity"},"bypassMailFee":{"type":"string","enum":["Y"],"nullable":true,"description":"Controls whether to charge the express mail fee for the reissued card. Default: blank.\nPattern: `\"Y\"` or blank\nExample: `\"Y\"`","example":"Y"}},"required":["accountNo","transactionId","type","apiLogin","apiTransKey","providerId"]}}}},"summary":"Modify Status","description":"Use the Modify Status endpoint to change the status of an account, a card, or both. This endpoint does not change any other kind of status.\n- Consult the Modify Status Types enumeration to see what is affected by each `type` value.\n - Use this endpoint with `type: 7` to activate a virtual card; for physical card activation use the Activate Card endpoint.\n- See the Lost, Stolen, or Damaged Cards guide for instructions on using types `8` and `9`.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"pmt_ref_no":{"type":"string","description":"A system-generated account number"},"account_status":{"type":"string","description":"The condition of the account after a modification"},"new_emboss_uuid":{"type":"string","nullable":true,"description":"UUID for a new_emboss record that has been sent to the embosser"}},"required":["account_status","pmt_ref_no"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.073,\n \"response_data\": {\n \"pmt_ref_no\": \"001109456424\",\n \"account_status\": \"N\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"DOGXLJ63DBF7EP19WPF7\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:39:13\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.0073\n \n 001109456424\n N\n \n \n \n \n C7H1193OXF056WEDYCRK\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:32:36\n"}}}},"description":""}},"operationId":"post_modifystatus"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/addAccount":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the primary account to associate with this secondary account.\nPattern: PAN or PRN\nExample: `\"112541764367\"`","example":"074103447228"},"prodId":{"type":"integer","format":"int32","minimum":0,"maximum":100000000,"description":"A unique product identifier from SoFi Tech Solutions. If this ID is for a business product then `businessName` is **required**.\nPattern: Integer\nExample: `501`","example":501},"location":{"type":"string","nullable":true,"maximum":20,"description":"Unique location identifier (`location`) as returned by the Create Location endpoint. This value is also returned by the Get Locations endpoint depending on the value of `locationType` when the location was created:\n* `0` or `2` — Returned in the `location_id` field\n* `1` — Returned in the `provider_specified_id` field\n\nPattern: Integer if `locationType: 0` or `locationType: 2`; max 15 characters if `locationType: 1`\nExample: `\"a455-3483\"`","example":"a455-3483"},"locationType":{"type":"integer","format":"int32","enum":[0,1,2],"nullable":true,"description":"Type of ID in `location`:\n* `0` — SoFi Tech Solutions location ID\n* `1` — Partner location ID\n* `2` — Don't validate\n\nPattern: Integer\nExample: `1`","example":1},"sharedBalance":{"type":"integer","format":"int32","enum":[0,1],"nullable":true,"description":"Specifies whether the secondary account will share the balance of the primary account.\n* `0` — Do not share the balance\n* `1` — Share the balance\n\nPattern: One digit\nExample: `1`","example":1},"fundingAccountNo":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12})$","description":"PRN of the <> funding account. **Required** if `prodId` is an RTF spending product.\nPattern: 12-digit numeric string\nExample: `\"143101204201\"`","example":"143101204201"},"newAccountNo":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of an existing instant issue card to attach to the new account. Required when `prodId` is an instant issue product.\nPattern: PAN or PRN\nExample: `\"112541764367\"`","example":"074103447228"}},"required":["accountNo","prodId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Add Account","description":"Use the Add Account endpoint to add a secondary account to an existing customer account. The account types that may be added include savings, overdraft, account with no card, virtual card, or personalized card.\n\nConsult the Adding an Account procedure for instructions on using this endpoint. Also see Create Account vs Add Account in the *About Accounts* guide.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"pmt_ref_no":{"type":"string","description":"A system-generated account number"},"product_id":{"type":"string","description":"System-generated integer ID for the product"},"galileo_account_number":{"type":"string","description":"System-generated integer account number, also known as balance ID"},"card_id":{"type":"string","nullable":true,"description":"Unique identifier for a card. None is returned if no card was created."},"card_number":{"type":"string","nullable":true,"description":"A PAN or 16 digit card number (usually masked)"},"expiry_date":{"type":"string","nullable":true,"description":"Expiration date of the card"},"card_security_code":{"type":"string","nullable":true,"description":"Card security code (CVV2)"},"emboss_line_2":{"type":"string","nullable":true,"description":"Second embossed line on a card"},"billing_cycle_day":{"type":"integer","format":"int32","nullable":true,"description":"The day of the month the billing cycle starts for the account"}},"required":["billing_cycle_day","galileo_account_number","pmt_ref_no","product_id"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.253,\n \"response_data\": {\n \"pmt_ref_no\": \"001109456192\",\n \"product_id\": \"88\",\n \"galileo_account_number\": \"462899\",\n \"card_id\": \"865120\",\n \"card_number\": \"487093XXXXXX3882\",\n \"card_security_code\": \"123\",\n \"emboss_line_2\": null,\n \"expiry_date\": null\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"AYA5QR4ZBO2E674YBVCX\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:38:45\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 2025-07-13 10:38:45\n \n 0001109456192\n 88\n 462899\n 865120\n 487093XXXXXX3882\n 123\n \n \n \n 0.251\n \n BA63R4ZBO2E674YCGH1\n \n \n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n"}}}},"description":""}},"operationId":"post_addaccount"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/updateAccount":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"idType":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of identifier in `id`. This parameter is **required** when `id` is populated. See the **`idType`** column in the Customer ID Types table for valid values. When using the SoFi Tech Solutions <> integration, only `2` and `15` are valid.\nPattern: Integer\nExample: `2`","example":2},"id":{"type":"string","nullable":true,"description":"The value of the primary identifier that is specified in `idType`. This parameter is **required** when using the SoFi Tech Solutions <> integration. This value cannot be changed after the customer passes ID verification. All letters will be converted to lowercase.\nPattern: As specified in the **Layout for `id`** column of the Customer ID Types enumeration\nExample: `\"123456789\"`","example":"123456789"},"idType2":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of identifier in `id2`. This parameter is **required** when `id2` is populated. See the **`idType`** column in the Customer ID Types table for valid values.\nPattern: Integer\nExample: `1`","example":1},"id2":{"type":"string","nullable":true,"description":"The value of the identifier that is specified in `idType2`. This value can be changed but not nullified or cleared. All letters will be converted to lowercase. See Specifying a card design for non-<> uses of `id2`.\nPattern: As specified in the **Layout for `id`** column of the Customer ID Types enumeration\nExample: `\"123456789012|ut|12/25/2020\"`","example":"123456789012|ut|12/25/2020"},"idType3":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of identifier in `id3`. This parameter is **required** when `id3` is populated. See the **`idType`** column in the Customer ID Types table for valid values.\nPattern: Integer\nExample: `13`","example":13},"id3":{"type":"string","nullable":true,"description":"The value of the identifier that is specified in `idType3`. All letters will be converted to lowercase. This value can be changed but not nullified or cleared.\nPattern: As specified in the **Layout for `id`** column of the Customer ID Types enumeration\nExample: `\"abc123456789|05-22-2027\"`","example":"abc123456789|05-22-2027"},"locationType":{"type":"integer","format":"int32","default":0,"enum":[0,1,2,3],"nullable":true,"description":"Type of ID in `location`:\n* `0` — SoFi Tech Solutions location ID\n* `1` — Partner location ID\n* `2` — Don't validate\n* `3` — Instant-issue location override. Valid for Create Account only. See Setup for Instant Issue for details.\n\nPattern: Integer\nExample: `0`","example":0},"location":{"type":"string","nullable":true,"description":"Unique location identifier (`location`) as returned by the Create Location endpoint. This value is also returned by the Get Locations endpoint depending on the value of `locationType` when the location was created:\n* `0` or `2` — Returned in the `location_id` field\n* `1` — Returned in the `provider_specified_id` field\n\nPattern: Integer if `locationType: 0` or `locationType: 2`; max 15 characters if `locationType: 1`\nExample: `\"a455-3483\"`","example":"a455-3483"},"locale":{"type":"string","default":"en_US","enum":["en_US","es_US","en_CA","fr_CA","es_MX","en_MX"],"nullable":true,"description":"The account holder language and localization preference. Valid values are `en_US`, `es_US`, `fr_CA`, `en_CA`, `es_MX`, `en_MX`. If the account holder address is outside the U.S., pass a non `_US` value for this parameter to disable U.S. address validation.\nPattern: Letters with underscore\nExample: `\"en_US\"`","example":"en_US"},"externalAccountId":{"type":"string","nullable":true,"maximum":30,"pattern":"^[A-Za-z0-9\\-+/=_]*$","description":"User-supplied identifier that is related to an external system. This ID is stored in the system in association with this account and can be provided in the <>s.\nPattern: Max 30 alphanumeric characters. Lowercase only.\nExample: `\"553b45sbs\"`","example":"553b45sbs"},"firstName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's first name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Ed\"`","example":"Ed"},"middleName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's middle name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"W\"`","example":"W"},"lastName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's last name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Harley\"`","example":"Harley"},"dateOfBirth":{"type":"string","format":"date-time","nullable":true,"description":"Account holder's birth date. This date is compared with the DOB product parameter when there is a minimum age requirement on the account.\nPattern: YYYY-MM-DD\nExample: `\"1980-01-01\"`","example":"1980-01-01"},"address1":{"type":"string","nullable":true,"description":"Account holder's first address line. Cannot be a P.O. box. Validation rules for `address1`.\nPattern: 4–40 alphanumeric characters\nExample: `\"33 Maple Street\"`","example":"33 Maple Street"},"address2":{"type":"string","nullable":true,"description":"Account holder's second address line. \nPattern: Max 40 alphanumeric characters and address symbols\nExample: `\"#4B\"`","example":"#4B"},"address3":{"type":"string","nullable":true,"description":"Account holder's third address line. \nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Carrera Central\"`","example":"Carrera Central"},"address4":{"type":"string","nullable":true,"description":"Account holder's fourth address line.\nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Barrio El Alhambra\"`","example":"Barrio El Alhambra"},"address5":{"type":"string","nullable":true,"description":"Account holder's fifth address line. \nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Piso 3\"`","example":"Piso 3"},"city":{"type":"string","nullable":true,"description":"Account holder's city.\nPattern: Max 30 characters: letters, spaces, hyphen and period\nExample: `\"Salt Lake City\"`","example":"Salt Lake City"},"state":{"type":"string","nullable":true,"description":"Account holder's state or province. \nPattern: String\nExample: `\"UT\"`","example":"UT"},"postalCode":{"type":"string","nullable":true,"minimum":4,"maximum":10,"pattern":"^[a-zA-Z0-9\\-\\ ]*$","description":"Account holder's postal code (ZIP code).\nPattern: `1234`, `12345`, `12345-1234`, or `K1A-1A1`\nExample: `\"84121\"`","example":"84121"},"countryCode":{"type":"string","nullable":true,"pattern":"^\\d{3}$","description":"Account holder's country. Three-digit UN M49 code, such as `840` for USA, `124` for Canada, `484` for Mexico, `170` for Colombia.\nPattern: 3-digit number\nExample: `\"840\"`","example":"840"},"primaryPhone":{"type":"string","nullable":true,"pattern":"^([0-9]+|null)$","description":"Account holder's primary phone number. When passing a value for this parameter, you must also pass `mobilePhoneCountryCode`.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\n Example: `\"8015556060\"`","example":"8013656060"},"otherPhone":{"type":"string","nullable":true,"pattern":"^([0-9]+|null)$","description":"Account holder's secondary phone number. When passing a value for this parameter, you must also pass `mobilePhoneCountryCode`.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\n Example: `\"8015556060\"`","example":"8013656060"},"mobilePhone":{"type":"string","nullable":true,"pattern":"^([0-9]+|null)$","description":"Account holder's mobile phone number. When passing a value for this parameter, you must also pass `mobilePhoneCountryCode`.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\n Example: `\"8015556060\"`","example":"8013656060"},"mobileCarrierId":{"type":"string","nullable":true,"description":"Account holder's mobile carrier. Configurable list.\nPattern: Configurable list\nExample: `\"8\"`","example":"8"},"email":{"type":"string","nullable":true,"minLength":3,"maxLength":63,"pattern":"[A-Za-z0-9À-öø-þŒœŠšŸŽž!-@\\[-`{-~¡-¿÷€]+","description":"Account holder's email.\nPattern: Email address, 3–63 characters\nExample: `\"user@fakedomain.com\"`","example":"user@fakedomain.com"},"webUid":{"type":"string","nullable":true,"minimum":4,"maximum":30,"pattern":"^[a-zA-Z0-9]+(?:[_-][a-zA-Z0-9]+)*$","description":"Account holder's username for the website hosted by SoFi Tech Solutions. Must be unique across the program.\nPattern: Alphanumeric, with first character a letter; case insensitive\nExample: `\"eharley\"`","example":"eharley"},"webPwd":{"type":"string","nullable":true,"description":"Account holder's password for the website hosted by SoFi Tech Solutions.\nPattern: Min 8 characters: must include upper-case character, lower-case character, and a number\nExample: `\"4j9KH3kkdh\"`","example":"4j9KH3kkdh"},"secretQuestion":{"type":"string","nullable":true,"maximum":50,"pattern":"^[\\w\\s\\?\\']*$","description":"Account holder's secret question for the website hosted by SoFi Tech Solutions.\nPattern: Max 50 characters: letters, spaces, `?`\nExample: `\"What was the name of your first pet?\"`","example":"What was the name of your first pet?"},"secretAnswer":{"type":"string","nullable":true,"maximum":50,"description":"Account holder's answer to `secretQuestion`.\nPattern: Max 50 characters: letters, spaces, `?`\nExample: `\"Larry\"`","example":"Larry"},"incomeSource":{"type":"string","nullable":true,"minimum":2,"maximum":60,"pattern":"^[a-zA-Z0-9\\|_\\-@\\.,' &]*$","description":"Account holder's employer name or income source.\nPattern: Max 60 characters: alphanumeric, space, underscore, hyphen, period, `@`, `&` and comma.\nExample: `\"Kroger Food & Drug\"`","example":"Kroger Food & Drug"},"occupation":{"type":"string","nullable":true,"minimum":2,"maximum":60,"pattern":"^[a-zA-Z0-9\\|_\\-@\\.,' &]*$","description":"Account holder's occupation.\nPattern: Max 60 characters: alphanumeric, space, underscore, hyphen, period, `@`, `&` and comma.\nExample: `\"Project Manager\"`","example":"Project Manager"},"nationality":{"type":"string","nullable":true,"maxLength":2,"description":"Account holder's nationality.\nPattern: 2-character ISO-3166-2 code\n:Example: `\"MX\"`","example":"MX"},"placeOfBirth":{"type":"string","nullable":true,"maxLength":6,"description":"Account holder's place of birth\nPattern: ISO-3166-2 subdivision code\nExample: MX-YUC","example":"MX-YUC"},"curp":{"type":"string","nullable":true,"maxLength":18,"description":"Account holder's <>\nPattern: 18 alphanumeric characters\nExample: `\"HRGRAL82050602H900\"`","example":"HRGRAL82050602H900"},"politicalAffiliation":{"type":"integer","format":"int32","nullable":true,"minimum":0,"maximum":1,"description":"Whether the account holder is a <>.\n- `1` — PEP\n- `0` — Not a PEP.\n","example":"1"},"kycRefNo":{"type":"string","nullable":true,"maxLength":36,"description":"<> reference number to track the KYC process for the account holder.\nPattern: 36 characters\nExample: `\"KYC123456789012312312312521312312312\"` ","example":"KYC123456789012312312312521312312312"},"monthlyIncome":{"type":"number","format":"float","nullable":true,"minimum":0,"maximum":9999999999,"description":"Monthly income for the account holder.\nPattern: Float between 0 and 9999999999\nExample: `3400.00`","example":"3400.00"},"externalCustomerId":{"type":"string","nullable":true,"maximum":512,"description":"User-supplied identifier that is related to an external system.\nPattern: Max 512 characters: all ASCII characters\nExample: `\"acv#-@45!sbsxm%-\"`","example":"acv#-@45!sbsxm%-"},"mailBounced":{"type":"string","nullable":true,"maximum":1,"pattern":"^[Y|N]$","description":"`Y` indicates that mail has been returned to sender.\nPattern: `Y` or `N`\nExample: `\"Y\"`","example":"Y"},"shipToAddress1":{"type":"string","nullable":true,"description":"First ship-to address line.\nPattern: Max 40 characters\nExample: `\"33 business parkway\"`","example":"33 business parkway"},"shipToAddress2":{"type":"string","nullable":true,"maximum":40,"description":"Second ship-to address line.\nPattern: Max 40 characters\nExample: `\"Suite 400\"`","example":"Suite 400"},"shipToCity":{"type":"string","nullable":true,"description":"Ship-to city.\nPattern: Max 30 characters\nExample: `\"Salt Lake City\"`","example":"Salt Lake City"},"shipToState":{"type":"string","nullable":true,"description":"Ship-to state. \nPattern: String\nExample: `\"UT\"`","example":"UT"},"shipToPostalCode":{"type":"string","nullable":true,"minimum":4,"maximum":10,"pattern":"^[a-zA-Z0-9\\-\\ ]*$","description":"Ship-to ZIP or postal code.\nPattern: `1234`, `12345`, `12345-1234`, `K1A-1A1`\nExample: `\"841213333\"`","example":"841213333"},"shipToCountryCode":{"type":"string","nullable":true,"pattern":"^\\d{3}$","description":"Ship-to country. Three-digit UN M49 country code, such as `840` for USA, `124` for Canada, `484` for Mexico, `170` for Colombia.\nPattern: 3-digit number\nExample: `\"840\"`","example":"840"},"shipToAddressPermanent":{"type":"string","nullable":true,"pattern":"^(1|0)$","description":"Pass `1` to always ship cards to the ship-to address instead of one time only.\nPattern: `0` or `1`\nExample: `\"1\"`","example":"1"},"embossLine2":{"type":"string","nullable":true,"maximum":28,"pattern":"^[\\d\\w\\s\\'\"!\\?\\-]*$","description":"Second line to emboss on the card.\nPattern: Supported characters\nExample: `\"Scarlet Ibis Shipping\"`","example":"Scarlet Ibis Shipping"},"businessName":{"type":"string","nullable":true,"description":"Account holder's business name. This field is **required** if `prodId` is a business product.\nPattern: 2–150 characters. See the supported character set.\nExample: `\"Ed%26Ted\"`","example":"Ed","pattern":"^[A-Za-z0-9_\\s\\'-\\.,\\?@&\\!#~\\*;\\+ '-]*$"},"mobilePhoneCountryCode":{"type":"string","nullable":true,"minimum":2,"maximum":4,"pattern":"^\\+[0-9]*$","description":"Account holder's mobile phone country code.\nPattern: A plus sign followed by 1–3 digits. See Phone Validation for valid values. \nExample: `\"+1\"`","example":"+1"}},"required":["transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Update Account","description":"Use the Update Account endpoint to modify customer profile information in an existing customer record. Pass only the parameters to modify — other parameters should be left blank. Only active accounts (`status: N`) can be updated using this endpoint, unless you set provider parameter UPDCZ to update accounts in `status: C` or `status: Z`.\n\n#### Nullifying data elements\nPass the string `null` for any of these parameters to update that value to `null`.\n\n| | | | |\n|:--|:--|:--|:--|\n| `firstName` | `middleName` | `lastName` | `address1` |\n| `city` | `state` | `postalCode` | `primaryPhone` |\n| `otherPhone` | `mobilePhone` | `shipToAddress1` | `webUid` |\n| `secretQuestion` | `secretAnswer` | `mailBounced` | `email`\\* |\n| `embossLine2` | | | |\n\\*Only if the provider parameter AENUL is set.\n\n[block:callout]\n\n{\n\"type\": \"warning\",\n\"title\": \"Warning\",\n\"body\": \"Exercise caution when nullifying a primary address — for compliance in the United States you must maintain a physical address as an individual cardholder's primary address.\"\n}\n[/block]\n\n#### Updating customer ID\nWhen you are using the SoFi Tech Solutions integrated <> process, you can update the primary customer ID (`id` and `idType`) as long as the customer has not passed customer identity verification. If the customer has already passed IVS, status code `415-02` is returned. Secondary and tertiary customer IDs (`id2`/`idType2` and `id3`/`idType3`) can be updated regardless of customer-verification status, but they cannot be nullified or cleared. If you omit those keys, the current value is not changed.\n\n#### Updating the ship-to address\nWhen updating the ship-to address for a customer, the elements `shipToAddress1`, `shipToCity`, `shipToState`, and `shipToPostalCode` are required – `shipToAddress2` is optional. You can retrieve the current customer ship-to address data using the Get Account Cards endpoint.\n\nBy default, the embosser sends the card to the primary address. To ship to a different address than the primary, use the ship-to address fields. If you pass `shipToAddressPermanent: 1` the embosser will always send cards to the ship-to address; otherwise, the ship-to address is used only for the current order.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"customer_profile":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"description":"The first name on a profile"},"middle_name":{"type":"string","nullable":true,"description":"The middle name on a profile"},"last_name":{"type":"string","nullable":true,"description":"The last name on a profile"},"preferred_name":{"type":"string","nullable":true,"description":"The preferred name on a profile, to appear on cards and CST profiles. The preferred name feature is currently in development. Additional configuration is required. Contact SoFi Tech Solutions if you are interested in this feature."},"preferred_name_only_on_card":{"type":"string","nullable":true,"description":"Whether the preferred name overrides only the `first_name` (default) or also `middle_name` and `last_name`. The preferred name feature is currently in development. Additional configuration is required. Contact SoFi Tech Solutions if you are interested in this feature."},"address_1":{"type":"string","nullable":true,"description":"Street and residence number on the account"},"address_2":{"type":"string","nullable":true,"description":"Additional address information on the account"},"city":{"type":"string","nullable":true,"description":"City for address information"},"state":{"type":"string","nullable":true,"description":"State for address information"},"postal_code":{"type":"string","nullable":true,"description":"A postal code for the address information"},"country_code":{"type":"string","nullable":true,"description":"The ISO 3166 international standard for country codes"},"phone":{"type":"string","nullable":true,"description":"The home phone number on a profile"},"mobile_phone":{"type":"string","nullable":true,"description":"The home phone number on a profile"},"mobile_phone_country_code":{"type":"string","nullable":true,"description":"The calling code for the mobile phone number on a profile"},"email":{"type":"string","nullable":true,"description":"The email address on a profile"},"ship_to_address":{"nullable":true,"type":"object","properties":{"address_1":{"type":"string","nullable":true,"description":"The ship to address on the account"},"address_2":{"type":"string","nullable":true,"description":"Additional ship to address information"},"city":{"type":"string","nullable":true,"description":"City for the ship to address"},"state":{"type":"string","nullable":true,"description":"State for ship to address"},"postal_code":{"type":"string","nullable":true,"description":"Postal code for ship to address"},"country_code":{"type":"string","nullable":true,"description":"ISO 3166 country code for ship to address"}},"required":["address_1","address_2","city","country_code","postal_code","state"]},"express_mail":{"type":"string","nullable":true,"description":"Whether or not the profile uses express mail service"},"related_accounts":{"type":"integer","format":"int32","nullable":true,"description":"The number of related accounts"},"occupation":{"type":"string","nullable":true,"description":"The occupation of a person as listed in a profile"},"income_source":{"type":"string","nullable":true,"description":"How the person on a profile earns income"},"emboss_line_2":{"type":"string","nullable":true,"description":"Second embossed line on a card"}},"required":["address_1","address_2","city","country_code","email","emboss_line_2","express_mail","first_name","income_source","last_name","middle_name","mobile_phone","occupation","related_accounts","ship_to_address","state"]}},"required":["customer_profile"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.355,\n \"response_data\": {\n \"customer_profile\": {\n \"first_name\": \"Anthony\",\n \"middle_name\": \"Jr\",\n \"last_name\": \"Testing\",\n \"address_1\": \"6510 S. Millrock\",\n \"address_2\": \"Suite 300\",\n \"city\": \"Slc\",\n \"state\": \"UT\",\n \"postal_code\": \"84121\",\n \"country_code\": \"000\",\n \"phone\": null,\n \"mobile_phone\": null,\n \"email\": \"eric+plus@tech.sofi.com\",\n \"ship_to_address\": {\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"state\": null,\n \"postal_code\": null,\n \"country_code\": null\n },\n \"express_mail\": \"N\",\n \"related_accounts\": null,\n \"occupation\": null,\n \"income_source\": null,\n \"emboss_line_2\": null\n }\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"68RGKCSVCYE59XZOIODN\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:39:52\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.167\n \n \n Anthony\n Jr\n Testing\n 33 Maple Street\n #4B\n Salt Lake City\n UT\n 84121\n 840\n 8013656060\n 8012222222\n eric+plus@tech.sofi.com\n \n 33 Business Parkway\n Suite 400\n Salt Lake City\n UT\n 84121\n 840\n \n N\n 369\n Project Manager\n Kroger Food & Drug\n Emboss Line 2\n \n \n \n \n \n AC3B9ADYN65DDIXSFZJ0\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:33:19\n"}}}},"description":""}},"operationId":"post_updateaccount"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/createAchTransaction":{"post":{"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"balance":{"type":"number","format":"float","description":"The available balance prior to applying the ACH transaction that is initiated by this endpoint call.For outgoing credits the balance adjustment happens shortly after calling this endpoint; for outgoing debits, the balance is adjusted when the hold period expires. An Events API message notifies when the transaction is posted to the account."},"ach_transaction_id":{"type":"string","description":"Unique identifier for the ACH transaction"}},"required":["ach_transaction_id","balance"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.574,\n \"response_data\": {\n \"balance\": 100,\n \"ach_transaction_id\": \"7425\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"EIDUWS2OWCAPJ4DET9SY\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-14 14:00:32\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 2025-07-14 14:10:12\n \n 1847.07\n J4DEW2T9SYCAPWSEIDUO\n \n 0.521\n \n 12345a\n \n \n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n"}}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"achAccountId":{"type":"integer","format":"int32","minimum":1,"maximum":999999999999,"description":"ACH account identifier (`ach_account_id`), as returned by Add ACH Account or Get ACH Accounts.\nPattern: Integer\nExample: `354656`","example":354656},"amount":{"type":"number","format":"float","minimum":0.01,"maximum":9999999.99,"description":"Currency amount as a whole or decimal amount.\nPattern: Positive integer or float\nExample: `100.00`, `100`, or `100.73`","example":25.5},"description":{"type":"string","nullable":true,"minLength":1,"maxLength":30,"pattern":"^[\\x20-\\x7E]+$","description":"Description for the ACH transaction.\nPattern: 1–30 supported characters\nExample: `\"One-time payroll load.\"`","example":"One-time payroll load."},"remittanceInfo":{"type":"string","nullable":true,"minLength":1,"maxLength":80,"pattern":"^[\\x20-\\x7E]+$","description":"Description for the remittance. This string populates the **Payment Related Information** field of the _ACH Addenda Record_ in the outgoing <>.\nPattern: 1–80 supported characters\nExample: `\"Payoff 2500 transfer initiated and verified to Acct 12345678.\"`","example":"Payoff 2500 transfer initiated and verified to Acct 12345678."},"debitCreditIndicator":{"type":"string","enum":["C","D"],"description":"Specifies whether to credit (`C`) or debit (`D`) the recipient account.\nPattern: String\nExample: `\"D\"`","example":"D"},"authorizationMethod":{"type":"string","nullable":true,"minLength":1,"maxLength":40,"pattern":"^[\\x20-\\x7E]+$","description":"The authorization method to use:\n* `online_or_mobile` — Web site or mobile app\n* `written_or_prearranged` — Signed document, agreement, or standing auth\n\nFor B2C debit transactions, missing or unsupported values are set to `null`, resulting in the PPD SEC code. For B2C credit and all non-B2C transactions, `authorizationMethod` is ignored and set to `null`.\n\nPattern: 1–40 characters\nExample: `\"online_or_mobile\"`","example":"online_or_mobile","enum":["online_or_mobile","written_or_prearranged"]},"companyEntryDesc":{"type":"string","minLength":1,"maxLength":10,"pattern":"^[\\x20-\\x7E]+$","description":"Describes the purpose of the ACH transaction. Possible values:\n* `PAYROLL` — Compensation-related payments for employees or contractors, including wages and salaries. Required only for the PPD SEC code.\n* `PURCHASE` — E-commerce-related debit transactions initiated by the cardholder. Required for WEB SEC code, except as permitted by the rule on Standing Authorization to use the TEL SEC code. \n* Free-text.\n\n See list of restricted values and use cases.\n\nPattern: Max 10 characters\nExample:`PAYROLL`","example":"PAYROLL"},"sameDay":{"type":"string","enum":["Y","N"],"nullable":true,"description":"Specifies whether this is a same-day transaction.\nPattern: String\nExample: `\"Y\"`","example":"Y"},"identNumber":{"type":"string","nullable":true,"minLength":1,"maxLength":15,"pattern":"^[a-zA-Z0-9 ]*$","description":"Provider-supplied identifier, external to the system. This value is required only for the `CIE` and `WEB` SEC codes.\nPattern: 1–15 characters\nExample: `\"999456789\"`","example":"999456789"},"processorToken":{"type":"string","nullable":true,"description":"Obtained from Plaid when using Plaid integration. Checks the balance of the ACH account to verify that there are sufficient funds for an ACH debit.\nPattern: String\nExample: `\"processor-production-35cd43b-adfc-d8aa-b331-c9ba0fdha881\"`","example":"processor-production-35cd43b-adfc-d8aa-b331-c9ba0fdha881"},"finicityBalanceCheck":{"type":"string","enum":["Y","N"],"nullable":true,"description":"Controls whether the system performs a real-time balance check on an ACH account linked via Mastercard Finicity. By default, this check confirms that there are sufficient funds in the recipient account before initiating an ACH debit. To bypass balance checks, set to `N`.\nPattern: String\nExample: `\"N\"`","example":"Y"},"holdDays":{"type":"integer","format":"int32","nullable":true,"minimum":0,"maximum":9999999999,"description":"The number of hold days to apply to this transaction, which overrides the hold days in product settings. This value applies only to outgoing ACH debits (`debitCreditIndicator: D`). This parameter is available only to clients who have obtained bank approval to use it. The ACOHD parameter must be set to use this parameter.\nPattern: Integer\nExample: 2","example":2}},"required":["accountNo","achAccountId","amount","companyEntryDesc","debitCreditIndicator","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Transactions"],"summary":"Create ACH Transaction","parameters":[],"description":"Use the Create ACH Transaction endpoint to originate an ACH transaction to move funds between a customer account (`accountNo`) and an existing ACH bank account (`achAccountId`). Use the Add ACH Account endpoint to add an ACH bank account.\n\nFor more information on this endpoint see Creating an ACH transaction in the *ACH Endpoints* guide.","operationId":"post_createachtransaction"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/addPaperBiller":{"post":{"parameters":[],"tags":["Transactions"],"summary":"Add Paper Biller","description":"Use the Add Paper Biller endpoint to create a custom paper biller for a customer and to schedule paper bill payments. Billers that are created with this endpoint will receive a paper check instead of an electronic payment.\n\nThe account must be active (`status: N`) to use this endpoint. See Creating a Billpay Transaction for further instructions on using this endpoint.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"biller_id":{"type":"string","description":"Positive integer value of a customer configured biller"},"biller_name":{"type":"string","description":"The paper biller name"}},"required":["biller_id","biller_name"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.04,\n \"response_data\": {\n \"biller_id\": \"9816\",\n \"biller_name\": \"My Landlord\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"SZZUDA1QWN9DUS6DXSVV\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:41:23\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.073\n \n 9832\n My Landlord\n \n \n \n \n SOLNP0QTNPKZDBA2H908\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:34:49\n"}}}},"description":""}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"billerName":{"type":"string","description":"Display name for the biller. You can have duplicate `billerName`s as long as the addresses are different.\nPattern: Max 50 alphanumeric characters, no punctuation\nExample: `\"My Landlord\"`","example":"My Landlord"},"billerAddress1":{"type":"string","minLength":3,"maxLength":80,"description":"First line of the biller address.\nPattern: Min of 3 and Max 80 alphanumeric characters\nExample: `\"33 Maple Street\"`","example":"33 Maple Street"},"billerAddress2":{"type":"string","nullable":true,"minLength":0,"maxLength":80,"description":"Second line of biller address.\nPattern: Max 30 alphanumeric characters\nExample: `\"#4B\"`","example":"#4B"},"billerCity":{"type":"string","minLength":1,"maxLength":60,"description":"Biller city.\nPattern: Max 30 letters and spaces\nExample: `\"Salt Lake City\"`","example":"Salt Lake City"},"billerState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AE","AP","AS","GU","MP","PR","VI","AB","BC","MB","NB","NL","NT","NS","NU","ON","PE","QC","SK","YT"],"minLength":2,"maxLength":2,"description":"Biller state or province.\nPattern: 2-character state or provincial abbreviation\nExample: `\"UT\"`","example":"UT"},"billerZip":{"type":"string","minLength":5,"maxLength":10,"pattern":"^[a-zA-Z0-9\\-\\ ]*$","description":"Biller postal code.\nPattern: `12345`, `12345-1234`, or `K1A-1A1`\nExample: `\"84121\"`","example":"84121"},"billerPhone":{"type":"string","nullable":true,"description":"Biller phone number or \"null\".\nPattern: Exactly 10 digits, no hyphens or other characters or \"null\"\nExample: `\"8013656060\"`","example":"8013656060"},"billerAccountNo":{"type":"string","minLength":1,"maxLength":30,"pattern":"^[A-Za-z0-9\\|_\\. '`\\?,!@$%#\\\"\\/\\-=]{1,30}$","description":"Account number that the account holder has with the biller. This value is not validated against a formatting mask. If there is no account number for the biller, pass `n/a`. You cannot edit this value with Modify Paper Biller. If the account holder submits an incorrect value, you must remove the biller and create the biller again with the correct account number. \nPattern: Alphanumeric string including hyphens and spaces.\nExample: `\"3333223323455555\"`","example":"3333223323455555"},"frequencyType":{"type":"string","enum":["O","W","M","Q","Y"],"nullable":true,"description":"Frequency of the bill payment:\n* `O` — One time\n* `W` — Weekly\n* `M` — Monthly\n* `Q` — Quarterly\n* `Y` — Yearly\n\nIf this value is not `O` then `nextDate` and `endDate` are **required**.\nPattern: One letter\nExample: `\"W\"`","example":"W"},"nextDate":{"type":"string","format":"date-time","nullable":true,"description":"The next date that the payment is scheduled.\nPattern: YYYY-MM-DD\nExample: `\"2015-02-04\"`","example":"2015-02-04"},"endDate":{"type":"string","format":"date-time","nullable":true,"description":"The last date that the payment is scheduled. Can be up to five years in the future, so if today is 20 Jan 2020, this parameter can be no later than 20 Jan 2025. However, if today's date is a leap day, such as 29 Feb 2020, the latest date can be 1 Mar 2025.\nPattern: YYYY-MM-DD\nExample: `\"2015-02-04\"`","example":"2015-02-04"},"amount":{"type":"number","format":"float","nullable":true,"minimum":0.01,"maximum":999999999999.99,"description":"Currency amount as a whole or decimal amount.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`","example":25.5}},"required":["accountNo","billerAccountNo","billerAddress1","billerCity","billerName","billerState","billerZip","transactionId","apiLogin","apiTransKey","providerId"]}}}},"operationId":"post_addpaperbiller"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/modifyPaperBiller":{"post":{"parameters":[],"tags":["Transactions"],"summary":"Modify Paper Biller","description":"Use the Modify Paper Biller endpoint to update a paper biller. All non-required fields are nullifiable. To cancel a scheduled series, either set `endDate` to the current date or pass `Null` for `frequencyType`, `nextDate` and `endDate`. The account must be active (`status: N`) to use this endpoint. ","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"biller_id":{"type":"string","description":"The ID assigned to the biller"},"address_1":{"type":"string","nullable":true,"description":"First address line of the biller"},"address_2":{"type":"string","nullable":true,"description":"Second address line of the biller"},"city":{"type":"string","nullable":true,"description":"City of the biller"},"state_province":{"type":"string","nullable":true,"description":"State of the biller"},"postal_code":{"type":"string","nullable":true,"description":"A postal code for the biller"},"phone":{"type":"string","nullable":true,"description":"The main phone number on the biller account"},"frequency_type":{"type":"string","nullable":true,"description":"Frequency of the bill payment: `O` (one time) `W` (weekly) `M` (monthly) `Q` (quarterly) `Y` (yearly)"},"next_date":{"type":"string","format":"date","nullable":true,"description":"The next date that the payment is scheduled"},"end_date":{"type":"string","format":"date","nullable":true,"description":"The last date that the payment is scheduled. Can be up to five years in the future"},"amount":{"type":"number","format":"float","nullable":true,"description":"Amount of the bill payment"}},"required":["biller_id"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.421,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"503e0841-2ae3-4174-86d9-45646894f859\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 16:07:44\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.411\n \n \n \n \n 8b8b1fd9-fe3c-45c4-9d6a-979aa2cd30a2\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 16:08:23\n"}}}},"description":""}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"billerId":{"type":"integer","format":"int32","description":"Identifier for the biller (`biller_id`) as returned by the Add Paper Biller or Get Billers endpoint.\nPattern: Integer\nExample: `2982`","example":2982},"frequencyType":{"type":"string","enum":["O","W","M","Q","Y"],"nullable":true,"description":"Frequency of the bill payment:\n* `O` — One time\n* `W` — Weekly\n* `M` — Monthly\n* `Q` — Quarterly\n* `Y` — Yearly\n\nIf this value is not `O` then `nextDate` and `endDate` are **required**.\nPattern: One letter\nExample: `\"W\"`","example":"W"},"nextDate":{"type":"string","format":"date-time","nullable":true,"description":"The next date that the payment is scheduled.\nPattern: YYYY-MM-DD\nExample: `\"2015-02-04\"`","example":"2015-02-04"},"endDate":{"type":"string","format":"date-time","nullable":true,"description":"The last date that the payment is scheduled. Can be up to five years in the future, so if today is 20 Jan 2020, this parameter can be no later than 20 Jan 2025. However, if today's date is a leap day, such as 29 Feb 2020, the latest date can be 1 Mar 2025.\nPattern: YYYY-MM-DD\nExample: `\"2015-02-04\"`","example":"2015-02-04"},"amount":{"type":"number","format":"float","nullable":true,"minimum":0.01,"maximum":999999999999.99,"description":"Currency amount as a whole or decimal amount.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`","example":25.5},"billerAddress1":{"type":"string","nullable":true,"minLength":0,"maxLength":80,"description":"First line of the biller address.\nPattern: Max 80 alphanumeric characters\nExample: `\"33 Maple Street\"`","example":"33 Maple Street"},"billerAddress2":{"type":"string","nullable":true,"minLength":0,"maxLength":80,"description":"Second line of biller address.\nPattern: Max 30 alphanumeric characters\nExample: `\"#4B\"`","example":"#4B"},"billerCity":{"type":"string","nullable":true,"minLength":1,"maxLength":60,"description":"Biller city.\nPattern: Max 30 letters and spaces\nExample: `\"Salt Lake City\"`","example":"Salt Lake City"},"billerState":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AE","AP","AS","GU","MP","PR","VI","AB","BC","MB","NB","NL","NT","NS","NU","ON","PE","QC","SK","YT"],"nullable":true,"minLength":2,"maxLength":2,"description":"Biller state or province.\nPattern: 2-character state or provincial abbreviation\nExample: `\"UT\"`","example":"UT"},"billerZip":{"type":"string","nullable":true,"minLength":5,"maxLength":10,"pattern":"^[a-zA-Z0-9\\-\\ ]*$","description":"Biller postal code.\nPattern: `12345`, `12345-1234`, or `K1A-1A1`\nExample: `\"84121\"`","example":"84121"},"billerPhone":{"type":"string","nullable":true,"description":"Biller phone number or \"null\".\nPattern: Exactly 10 digits, no hyphens or other characters or \"null\"\nExample: `\"8013656060\"`","example":"8013656060"}},"required":["accountNo","billerId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"operationId":"post_modifypaperbiller"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/addRppsBiller":{"post":{"parameters":[],"tags":["Transactions"],"summary":"Add RPPS Biller","description":"Use the Add RPPS Biller endpoint to create an <> biller for a customer and to schedule bill payments. Before calling this endpoint, use the Search Biller Directory endpoint to find the biller and obtain the `rpps_biller_id`.\n\nThe account must be active (`status: N`) to use this endpoint. See Creating a Billpay Transaction for further instructions on using this endpoint.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"biller_id":{"type":"string","description":"Positive integer value used to identify the biller"},"name":{"type":"string","description":"The RPPS biller name"}},"required":["biller_id","name"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"response\": {\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.067,\n \"response_data\": {\n \"biller_id\": 9817,\n \"name\": \"Comcast - Lompoc 2\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": \"\",\n \"transaction_id\": \"YLA44GUKZV4Y1WOKDSPY\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 12:34:49\"\n }\n }"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.067\n \n 9817\n Comcast - Lompoc 2\n \n \n \n \n YLA44GUKZV4Y1WOKDSPY\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:34:49\n"}}}},"description":""}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"rppsBillerId":{"type":"string","pattern":"^[0-9]{10}$","description":"The `rpps_biller_id` as returned by Search Biller Directory. This value must be zero-padded on the left to be 10 digits, so you would pass `rpps_biller_id: 1234` as `rppsBillerId: 0000001234`.\nPattern: Exactly 10 digits\nExample: `\"0000001234\"`","example":"0000001234"},"billerAccountNo":{"type":"string","minLength":1,"maxLength":30,"pattern":"^[A-Za-z0-9\\|_\\. '`\\?,!@$%#\\\"\\/\\-=]{1,30}$","description":"The account number that the account holder has with the biller. When applicable, the account number is validated against the `biller_account_no_patterns` that were returned by Search Biller Directory. You cannot edit this value with Modify RPPS Biller. If the account holder submits an incorrect value, you must remove the biller and create the biller again with the correct account number.\nPattern: Alphanumeric string including hyphens and spaces.\nExample: `\"3333223323455555\"`","example":"3333223323455555"},"frequencyType":{"type":"string","enum":["O","W","M","Q","Y"],"nullable":true,"description":"Frequency of the bill payment:\n* `O` — One time\n* `W` — Weekly\n* `M` — Monthly\n* `Q` — Quarterly\n* `Y` — Yearly\n\nIf this value is not `O` then `nextDate` and `endDate` are **required**.\nPattern: One letter\nExample: `\"W\"`","example":"W"},"nextDate":{"type":"string","format":"date-time","nullable":true,"description":"The next date that the payment is scheduled.\nPattern: YYYY-MM-DD\nExample: `\"2015-02-04\"`","example":"2015-02-04"},"endDate":{"type":"string","format":"date-time","nullable":true,"description":"The last date that the payment is scheduled. Can be up to five years in the future, so if today is 20 Jan 2020, this parameter can be no later than 20 Jan 2025. However, if today's date is a leap day, such as 29 Feb 2020, the latest date can be 1 Mar 2025.\nPattern: YYYY-MM-DD\nExample: `\"2015-02-04\"`","example":"2015-02-04"},"amount":{"type":"number","format":"float","nullable":true,"minimum":0.01,"maximum":999999999999.99,"description":"Currency amount as a whole or decimal amount.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`","example":25.5}},"required":["accountNo","billerAccountNo","rppsBillerId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"operationId":"post_addrppsbiller"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/cancelBillPayment":{"post":{"parameters":[],"tags":["Transactions"],"summary":"Cancel Bill Payment","description":"Use the Cancel Bill Payment endpoint to cancel the following types of billpay transactions:\n * Paper transactions in status `N`, `W` or `P`.\n * Electronic (RPPS) transactions in status `N`\n * Non-recurring paper or electronic transactions that are scheduled for a future date\n\nIf the transaction is in another status, the endpoint returns `status_code: 435-02`See Managing Billpay Transactions for instructions on using this endpoint.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"billpay_transaction_id":{"type":"string","description":"An ID assigned to a bill payment transaction"},"old_balance":{"type":"number","format":"float","description":"The balance of the account before the payment is canceled"},"new_balance":{"type":"number","format":"float","description":"The balance of the account after the payment is canceled"}},"required":["billpay_transaction_id","new_balance","old_balance"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.395,\n \"response_data\": {\n \"billpay_transaction_id\": \"618663\",\n \"old_balance\": 19990,\n \"new_balance\": 20000\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"0e914c39-4bed-4aae-941a-2d85f3e6f7b1\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 13:39:13\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.035\n \n 618663\n 19990\n 20000\n \n \n \n \n 15bac7c1-1131-4426-be58-4ee34fbb9c34\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 13:39:14\n"}}}},"description":""}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"billpayTransactionId":{"type":"integer","format":"int32","minimum":0,"maximum":1000000000000000000,"description":"The billpay transaction ID (`billpay_transaction_id`) as returned by the Create Bill Payment or Get Bill Payment History endpoint.\nPattern: Positive integer\nExample: `3433443`","example":3433443}},"required":["accountNo","billpayTransactionId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"operationId":"post_cancelbillpayment"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/createBillPayment":{"post":{"parameters":[],"tags":["Transactions"],"summary":"Create Bill Payment","description":"Use the Create Bill Payment endpoint to create a bill payment transaction. Before you can use this endpoint, you must create the biller.\n\nThe account must be active (`status: N`) to use this endpoint. See Creating a Billpay Transaction for further instructions on using this endpoint.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"billpay_transaction_id":{"type":"string","description":"An ID assigned to a bill payment transaction"},"old_balance":{"type":"number","format":"float","description":"The balance of the account before the payment is processed"},"new_balance":{"type":"number","format":"float","description":"The balance on the account after the payment is processed"},"process_date":{"type":"string","format":"date","description":"The date the payment was processed"},"fee_amount":{"type":"number","format":"float","description":"The fee amount assessed for this bill payment record"},"maximum_amount":{"type":"number","format":"float","nullable":true,"description":"A dollar limit on each bill-pay transaction"}},"required":["billpay_transaction_id","fee_amount","maximum_amount","new_balance","old_balance","process_date"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.93,\n \"response_data\": {\n \"billpay_transaction_id\": \"618664\",\n \"old_balance\": 20000,\n \"new_balance\": 19950,\n \"process_date\": \"2025-07-15\",\n \"fee_amount\": \"2.5\",\n \"maximum_amount\": 250\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"50c5ebad-2806-4518-ac93-b91ccca148c3\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 13:43:28\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.082\n \n 618666\n 20000\n 19950\n 2025-07-15\n 2.5\n 250\n \n \n \n \n 6ae347b5-bec9-4249-9e63-af8aad5c544a\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 13:43:29\n"}}}},"description":""}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"amount":{"type":"number","format":"float","minimum":0.01,"description":"Currency amount as a whole or decimal amount.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`","example":25.5},"billerId":{"type":"integer","format":"int32","minimum":1,"description":"Identifier for the biller (`biller_id`) as returned by the Add RPPS Biller, Add Paper Biller or Get Billers endpoint.\nPattern: Positive integer\nExample: `37323`","example":37323},"processDate":{"type":"string","format":"date","nullable":true,"description":"Date in the future to process the payment. Leave blank to process the payment immediately.\nPattern: YYYY-MM-DD\nExample: `2025-01-01`","example":"2025-01-01"},"memo":{"type":"string","nullable":true,"minLength":1,"maxLength":50,"pattern":"^[A-Za-z0-9|_. '?,!@$%#\"-=~]","description":"String to print in the memo field of printed paper checks.\nPattern: Max 50 alphanumeric characters including punctuation\nExample: `For babysitting`","example":"For babysitting"}},"required":["accountNo","amount","billerId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"operationId":"post_createbillpayment"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getBillers":{"post":{"parameters":[],"tags":["Transactions"],"summary":"Get Billers","description":"Use the Get Billers endpoint to retrieve the billers for the specified customer account.\n\nSee Creating a Billpay Transaction for instructions on using this endpoint.\n\nSee Record-Set Pagination for instructions on using the paging parameters.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"billers":{"type":"array","description":"List of billers","items":{"type":"object","properties":{"account_number":{"type":"string","description":"The account number of the biller entity"},"address_1":{"type":"string","nullable":true,"description":"Street and residence number on the account"},"address_2":{"type":"string","nullable":true,"description":"Additional address information on the account"},"biller_id":{"type":"string","description":"An ID assigned to the biller"},"city":{"type":"string","nullable":true,"description":"City for address information"},"name":{"type":"string","nullable":true,"description":"A name used to identify a biller entity"},"nickname":{"type":"string","nullable":true,"description":"A substring of the biller `name`."},"phone":{"type":"string","nullable":true,"description":"The main phone number on the biller account"},"postal_code":{"type":"string","nullable":true,"description":"A postal code for the address information"},"state_province":{"type":"string","nullable":true,"description":"State for address information"},"type":{"type":"string","description":"The type of biller: `P` (paper) or `E` (electronic, RPPS)"},"frequency_type":{"type":"string","nullable":true,"description":"Frequency of the bill payment"},"next_date":{"type":"string","format":"date","nullable":true,"description":"The next date that the payment is scheduled"},"end_date":{"type":"string","format":"date","nullable":true,"description":"The last date that the payment is scheduled. Can be up to five years in the future"},"amount":{"type":"number","format":"float","nullable":true,"description":"Currency amount as a whole or decimal amount"}},"required":["account_number","biller_id","name","type"]}},"found":{"type":"integer","format":"int32","description":"The total number of billers found"},"page":{"type":"integer","format":"int32","description":"The page number to be retrieved in the context of recordset paging"},"total_record_count":{"type":"integer","format":"int32","description":"Number of records in the accounts list display"},"number_of_pages":{"type":"integer","format":"int32","description":"Total number of pages in the accounts list display"}},"required":["billers","found","number_of_pages","page","total_record_count"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.066,\n \"response_data\": {\n \"billers\": [\n {\n \"account_number\": \"ev2222222\",\n \"address_1\": \"PO Box 1357\",\n \"address_2\": null,\n \"biller_id\": \"393\",\n \"city\": \"East Bend\",\n \"name\": \"Eastern Utilities\",\n \"nickname\": \"Eastern Utilities\",\n \"phone\": \"8015551212\",\n \"postal_code\": \"84120\",\n \"state_province\": \"UT\",\n \"type\": \"P\"\n }\n ],\n \"found\": 4,\n \"number_of_pages\": 4,\n \"page\": 1,\n \"total_record_count\": 4\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"d09aaa50-caa5-455f-9d0e-b54372164311\"\n },\n \"system_timestamp\": \"2023-07-31 16:26:30\",\n \"rtoken\": \"8fab0829-9e0f-42c7-ad07-e3a1c04a14ba\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.066\n \n \n ev2222222\n PO Box 1357\n \n 393\n East Bend\n Eastern Utilities\n Eastern Utilities\n 8015551212\n 84120\n UT\n P\n \n 4\n 4\n 1\n 4\n \n \n \n \n d09aaa50-caa5-455f-9d0e-b54372164311\n \n 2023-07-31 16:26:30\n 8fab0829-9e0f-42c7-ad07-e3a1c04a14ba\n"}}}},"description":""}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"recordCnt":{"type":"integer","format":"int32","nullable":true,"minimum":1,"maximum":99999,"description":"The maximum number of records per page to be returned.\nPattern: Positive integer `1-99999`\nExample: `100`","example":100},"page":{"type":"integer","format":"int32","default":1,"description":"The number of the page to retrieve.\nPattern: Integer value of `1` or greater\nExample: `3`","example":3}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"operationId":"post_getbillers"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/removeBiller":{"post":{"parameters":[],"tags":["Transactions"],"summary":"Remove Biller","description":"Use the Remove Biller endpoint to delete an <> or paper biller. When you delete a biller, the future scheduled transactions for that biller are not deleted.\n\nSee Managing Billpay Transactions for instructions on using this endpoint.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","type":"object","properties":{}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.053,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"MOTDDXTMSM49F8ZX58CU\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:41:23\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.00714\n \n \n \n \n C273MCSXWDD65ZXCCX5A\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:34:53\n"}}}},"description":""}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"billerId":{"type":"integer","format":"int32","description":"Identifier for the biller (`biller_id`) as returned by the Add RPPS Biller, Add Paper Biller or Get Billers endpoint.\nPattern: Integer\nExample: `2982`","example":37323}},"required":["accountNo","billerId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"operationId":"post_removebiller"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getBillPayHistory":{"post":{"parameters":[],"tags":["Transactions"],"summary":"Get Bill Payment History","description":"Use the Get Bill Payment History endpoint to retrieve bill payment transactions between the specified dates, including scheduled transactions. You can get the history for the specified account or for all related accounts.\n\nSee Managing Billpay Transactions for instructions on using this endpoint.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"found":{"type":"integer","format":"int32","description":"The total number of bill payments found"},"bill_payments":{"type":"array","description":"List of bill payment objects","items":{"type":"object","properties":{"pmt_ref_no":{"type":"string","description":"A system-generated account number"},"billpay_transaction_id":{"type":"string","description":"An ID assigned to a bill payment transaction"},"amount":{"type":"string","description":"The amount of the bill payment"},"process_date":{"type":"string","format":"date-time","nullable":true,"description":"The date the payment was processed"},"biller_id":{"type":"string","description":"Positive integer value of a customer configured biller"},"name":{"type":"string","nullable":true,"description":"The name of the biller"},"nickname":{"type":"string","nullable":true,"description":"A nickname used to identify a biller entity"},"status":{"type":"string","description":"The status of the payment. See Bill Payment Statuses."},"type":{"type":"string","description":"`P` for paper or `E` for electronic"},"external_trans_id":{"type":"string","nullable":true,"description":"The `transactionId` from the Create Bill Payment call that created the transaction."},"printed_date":{"type":"string","format":"date-time","nullable":true,"description":"The date the paper check was mailed or the electronic bill payment was sent to Mastercard."},"cleared_date":{"type":"string","format":"date-time","nullable":true,"description":"The date the paper check cleared the bank."}},"required":["amount","biller_id","billpay_transaction_id","cleared_date","external_trans_id","name","nickname","pmt_ref_no","printed_date","process_date","status","type"]}}},"required":["bill_payments","found"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.406,\n \"response_data\": {\n \"found\": 3,\n \"bill_payments\": [\n {\n \"pmt_ref_no\": \"005461527202\",\n \"billpay_transaction_id\": \"618685\",\n \"amount\": \"10\",\n \"process_date\": \"2025-07-15 14:20:11\",\n \"biller_id\": \"248806\",\n \"name\": \"965199ce-83da-487b-a723-75a9a1137aec\",\n \"nickname\": \"965199ce-83da-487b-a723-75a9a1137aec\",\n \"status\": \"N\",\n \"type\": \"P\",\n \"external_trans_id\": null,\n \"printed_date\": null,\n \"cleared_date\": null\n },\n {\n \"pmt_ref_no\": \"005461527202\",\n \"billpay_transaction_id\": \"618684\",\n \"amount\": \"10\",\n \"process_date\": \"2025-07-15 14:20:11\",\n \"biller_id\": \"248804\",\n \"name\": \"51aa2af9-3d33-4238-8fca-06c2d4d7afa4\",\n \"nickname\": \"51aa2af9-3d33-4238-8fca-06c2d4d7afa4\",\n \"status\": \"N\",\n \"type\": \"E\",\n \"external_trans_id\": null,\n \"printed_date\": null,\n \"cleared_date\": null\n },\n {\n \"pmt_ref_no\": \"005461527202\",\n \"billpay_transaction_id\": \"618683\",\n \"amount\": \"10\",\n \"process_date\": \"2025-07-15 14:20:11\",\n \"biller_id\": \"248802\",\n \"name\": \"6e9b3bf8-e130-4849-b2a1-548a38a93099\",\n \"nickname\": \"6e9b3bf8-e130-4849-b2a1-548a38a93099\",\n \"status\": \"N\",\n \"type\": \"E\",\n \"external_trans_id\": null,\n \"printed_date\": null,\n \"cleared_date\": null\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"598adc67-9fe8-4f6a-bb60-8a11c3d9a4a6\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 14:20:12\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.022\n \n 3\n \n \n 005461527202\n 618685\n 10\n 2025-07-15 14:20:11\n 248806\n 965199ce-83da-487b-a723-75a9a1137aec\n 965199ce-83da-487b-a723-75a9a1137aec\n N\n P\n \n \n \n \n \n 005461527202\n 618684\n 10\n 2025-07-15 14:20:11\n 248804\n 51aa2af9-3d33-4238-8fca-06c2d4d7afa4\n 51aa2af9-3d33-4238-8fca-06c2d4d7afa4\n N\n E\n \n \n \n \n \n 005461527202\n 618683\n 10\n 2025-07-15 14:20:11\n 248802\n 6e9b3bf8-e130-4849-b2a1-548a38a93099\n 6e9b3bf8-e130-4849-b2a1-548a38a93099\n N\n E\n \n \n \n \n \n \n \n \n \n d896d23f-5d8e-452e-a537-e6b2d621d0ca\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 14:20:13\n"}}}},"description":""}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"startDate":{"type":"string","format":"date","description":"The beginning date for the date range, either a date or a date-time.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"endDate":{"type":"string","format":"date","description":"The end date for the date range, either a date or a date-time. Must be equal to or later than `startDate`. Max 1098 days (~3 years) after `startDate`. \nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"includeRelated":{"type":"integer","format":"int32","default":0,"enum":[0,1],"nullable":true,"description":"Whether to return transactions for all accounts from the same account holder (`client_id`).\n- `0` or _blank_ — Retrieve only the transactions for the specified account.\n- `1` — Retrieve all transactions from the same account holder.\n\nPattern: Integer\nExample: `1`","example":1},"recordCnt":{"type":"integer","format":"int32","default":400,"nullable":true,"minimum":1,"maximum":99999,"description":"The maximum number of records to be returned in the method response.\nPattern: Positive integer value in the range of 1 and 99999.\nExample: `100`","example":100}},"required":["accountNo","endDate","startDate","transactionId","apiLogin","apiTransKey","providerId"]}}}},"operationId":"post_getbillpayhistory"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/modifyRppsBiller":{"post":{"parameters":[],"tags":["Transactions"],"summary":"Modify RPPS Biller","description":"Use the Modify RPPS Biller endpoint to update an <> biller. All non-required fields are nullifiable. To cancel a scheduled series, either set `endDate` to the current date or pass `Null` for `frequencyType`, `nextDate` and `endDate`. The account must be active (`status: N`) to use this endpoint. ","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","type":"object","properties":{}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.418,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"15455f7a-724e-4827-bd5c-0ede181a0dd4\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 16:09:19\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.406\n \n \n \n \n dff977be-6fbc-450c-b8ae-ca07a678820c\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 16:09:53\n"}}}},"description":""}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"billerId":{"type":"integer","format":"int32","description":"Identifier for the biller (`biller_id`) as returned by the Add RPPS Biller or Get Billers endpoint. Do not use the `rpps_biller_id` from Search Biller Directory.\nPattern: Integer\nExample: `2982`","example":2982},"frequencyType":{"type":"string","enum":["O","W","M","Q","Y"],"nullable":true,"description":"Frequency of the bill payment:\n* `O` — One time\n* `W` — Weekly\n* `M` — Monthly\n* `Q` — Quarterly\n* `Y` — Yearly\n\nIf this value is not `O` then `nextDate` and `endDate` are **required**.\nPattern: One letter\nExample: `\"W\"`","example":"W"},"nextDate":{"type":"string","format":"date-time","nullable":true,"description":"The next date that the payment is scheduled.\nPattern: YYYY-MM-DD\nExample: `\"2015-02-04\"`","example":"2015-02-04"},"endDate":{"type":"string","format":"date-time","nullable":true,"description":"The last date that the payment is scheduled. Can be up to five years in the future, so if today is 20 Jan 2020, this parameter can be no later than 20 Jan 2025. However, if today's date is a leap day, such as 29 Feb 2020, the latest date can be 1 Mar 2025.\nPattern: YYYY-MM-DD\nExample: `\"2015-02-04\"`","example":"2015-02-04"},"amount":{"type":"number","format":"float","nullable":true,"minimum":0.01,"maximum":999999999999.99,"description":"Currency amount as a whole or decimal amount.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`","example":25.5}},"required":["accountNo","billerId","frequencyType","transactionId","apiLogin","apiTransKey","providerId"]}}}},"operationId":"post_modifyrppsbiller"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getCard":{"post":{"summary":"Get Card","description":"Use the Get Card endpoint to retrieve information for the specified card.\n\n[block:callout]\n\n{\n\"type\": \"info\",\n\"title\": \"Note\",\n\"body\": \"You can receive PCI-sensitive information only if your provider parameters permit it.\"\n}\n[/block]\n\n","parameters":[],"tags":["Accounts and Cards"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <>, <> or <> of the account. For card-specific endpoints such as this one, the CAD is preferred. Do not use the PRN if more than one card has ever been associated with this account.\nPattern: PAN, PRN, or CAD\nExample: `\"074103447228\"`","example":"074103447228"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"card_number":{"type":"string","description":"A 16-digit PAN. Set CINFI when PCI-compliant to see the unmasked PAN."},"expiry_date":{"type":"string","format":"date-time","nullable":true,"description":"_Supported data types: date, datetime, null, empty string._ Expiration date of the card (YYYY-MM-DD). (The card expires on the last day of the month [MM], not on the day [DD].) Set CINFD when PCI-compliant to see this value. Set CXPTM to include the time (YYYY-MM-DD hh:mm:ss). When this field is present inside the `embossed_cards` object, it is not nullable."},"card_security_code":{"type":"string","nullable":true,"description":"The card verification value (CVV2) printed on the card. Set CINFS when PCI-compliant to see this value."},"status":{"type":"string","description":"The status of the card. See Card Statuses for valid values."},"card_id":{"type":"string","description":"Also called the CAD, a system-generated identifier for a card"},"external_card_id":{"type":"string","nullable":true,"description":"User-specified external card identifier"},"pmt_ref_no":{"type":"string","description":"Payment reference number (PRN). A 12-digit system-generated account number"},"first_name":{"type":"string","nullable":true,"description":"The first name on the customer profile"},"middle_name":{"type":"string","nullable":true,"description":"The middle name on the profile"},"last_name":{"type":"string","nullable":true,"description":"The last name on the profile"},"encrypted_card_number":{"type":"string","nullable":true,"description":"Encrypted PAN"},"encrypted_expiry_date":{"type":"string","nullable":true,"description":"Encrypted expiration date"},"emboss_uuid":{"type":"string","nullable":true,"description":"UUID for an emboss record that has been sent to the embosser. When this field is present outside the `embossed_cards` object, it contains the most recent emboss UUID."},"embossed_cards":{"type":"array","nullable":true,"description":"List of emboss records, one for each time the card was sent to the embosser. This object is populated only when emboss records exist.","items":{"nullable":true,"type":"object","properties":{"emboss_uuid":{"type":"string","nullable":true,"description":"UUID for an emboss record that has been sent to the embosser. When this field is present outside the `embossed_cards` object, it contains the most recent emboss UUID."},"status":{"type":"string","description":"Emboss status. For valid values see the Emboss Statuses enumeration."},"created_date":{"type":"string","format":"date-time","description":"The date the card was created in the system (YYYY-MM-DD). Set CXPTM to include the time (YYYY-MM-DD hh:mm:ss)."},"emboss_date":{"type":"string","format":"date","description":"The date the card was sent to the embosser (YYYY-MM-DD)"},"expiry_date":{"type":"string","format":"date-time","nullable":true,"description":"Expiration date of the card (YYYY-MM-DD). (The card expires on the last day of the month [MM], not on the day [DD].) Set CINFD when PCI-compliant to see this value. Set CXPTM to include the time (YYYY-MM-DD hh:mm:ss)."},"product_id":{"type":"string","nullable":true,"description":"Product ID of the card at the time of embossing"},"shipping_type":{"type":"string","description":"The shipping type used to send the card to the cardholder: `standard` or `express`"},"emboss_name":{"type":"string","nullable":true,"description":"The cardholder name embossed on the card, from the emboss record."},"shipment_info":{"nullable":true,"description":"Most recent USPS IMb shipment tracking event for this card. Null when no tracking data exists.","type":"object","properties":{"tracking_number":{"type":"string","description":"USPS Intelligent Mail barcode (IMb) tracking number."},"status":{"type":"string","description":"Current tracking status. One of: `SHIPPED`, `DELIVERY_SCAN`, `RTS` (Return to Sender)."},"mailed_date":{"type":"string","nullable":true,"description":"Date the card was mailed by G&D (YYYY-MM-DD)."},"shipping_method":{"type":"string","nullable":true,"description":"Shipping method as reported by G&D (e.g. `FirstClass`, `Priority`)."},"scan_date":{"type":"string","nullable":true,"description":"Date and time of the most recent delivery scan (YYYY-MM-DD HH:MM:SS)."},"scan_location":{"type":"string","nullable":true,"description":"City and state of the most recent scan event."},"scan_status":{"type":"string","nullable":true,"description":"Human-readable scan status description (e.g. `Delivery Prep by MM/DD/YYYY`)."},"expected_delivery_date":{"type":"string","nullable":true,"description":"Estimated delivery date extracted from the scan status (YYYY-MM-DD)."}},"required":["status","tracking_number"]}},"required":["created_date","emboss_date","emboss_name","emboss_uuid","expiry_date","product_id","shipping_type","status"]}},"freeze_info":{"type":"object","properties":{"status":{"type":"string","description":"Whether the card is `Frozen` or `Unfrozen`."},"start_date":{"type":"string","format":"date-time","nullable":true,"description":"Start date-time for the card freeze."},"end_date":{"type":"string","format":"date-time","nullable":true,"description":"End date-time for the card freeze."}},"required":["end_date","start_date","status"]},"pin_fail_count":{"type":"string","nullable":true,"description":"The number of failed-PIN attempts in the counter"},"pin_fail_date":{"type":"string","format":"date-time","nullable":true,"description":"Date of the last failed PIN attempt"},"spend_controls":{"type":"object","properties":{"available_credit":{"type":"string","nullable":true,"description":"The amount available to be charged to a credit card"},"single_use":{"type":"string","nullable":true,"description":"Whether this is an alias credit card number, exhausted after one use"},"credit_limit":{"type":"string","nullable":true,"description":"The maximum outstanding balance allowed on a credit card"}},"required":["available_credit","credit_limit","single_use"]},"ssn":{"type":"string","nullable":true,"description":"The Social Security Number associated with the account. Set CINFN when PCI-compliant to see this value."},"card_format":{"type":"string","nullable":true,"description":"Whether the card is `Physical` or `Virtual`."},"card_type":{"type":"string","nullable":true,"description":"Whether the card account is `Credit` or `Debit`."},"activation_date":{"type":"string","nullable":true,"description":"Date and time the card was activated (YYYY-MM-DD HH:MM:SS). Null if the card has not yet been activated."},"address_1":{"type":"string","nullable":true,"description":"First line of the account holder's address"},"address_2":{"type":"string","nullable":true,"description":"Second line of the account holder's address"},"city":{"type":"string","nullable":true,"description":"Account holder's city"},"state":{"type":"string","nullable":true,"description":"Account holder's state"},"postal_code":{"type":"string","nullable":true,"description":"Account holder's postal code"},"country_code":{"type":"string","nullable":true,"description":"Identifies the account holder's country. ISO 3166 numeric."},"preferred_name":{"type":"string","nullable":true,"description":"The preferred name on a profile, to appear on cards and CST profiles. The preferred name feature is currently in development. Additional configuration is required. Contact SoFi Tech Solutions if you are interested in this feature."}},"required":["card_id","card_number","card_security_code","emboss_uuid","embossed_cards","encrypted_card_number","encrypted_expiry_date","expiry_date","external_card_id","first_name","freeze_info","last_name","middle_name","pin_fail_count","pin_fail_date","pmt_ref_no","spend_controls","status"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.464,\n \"response_data\": {\n \"card_number\": \"524630XXXXXX0810\",\n \"expiry_date\": \"2030-02-04\",\n \"card_security_code\": \"123\",\n \"status\": \"N\",\n \"card_id\": \"2467493\",\n \"external_card_id\": null,\n \"pmt_ref_no\": \"999127602949\",\n \"first_name\": \"Jordi\",\n \"middle_name\": \"\",\n \"last_name\": \"Cardona\",\n \"encrypted_card_number\": null,\n \"encrypted_expiry_date\": null,\n \"new_emboss_uuid\": \"f4b2a8e9-91cf-4e6a-8b4f-3d2d8f0d2c17\",\n \"embossed_cards\": [\n {\n \"status\": \"N\",\n \"emboss_uuid\": \"f4b2a8e9-91cf-4e6a-8b4f-3d2d8f0d2c17\",\n \"created_date\": \"2025-02-04\",\n \"emboss_date\": \"2025-02-04\",\n \"expiry_date\": \"2030-02-04\",\n \"shipping_type\": \"standard\",\n \"product_id\": \"6552\"\n }\n ],\n \"freeze_info\": {\n \"status\": \"Unfrozen\",\n \"start_date\": null,\n \"end_date\": null\n },\n \"pin_fail_count\": \"0\",\n \"pin_fail_date\": null,\n \"spend_controls\": {\n \"available_credit\": null,\n \"single_use\": null,\n \"credit_limit\": null\n },\n \"ssn\": \"\",\n \"card_format\": \"Physical\",\n \"card_type\": \"Debit\",\n \"address_1\": \"Calle Reforma 128\",\n \"address_2\": \"Colonia Centro\",\n \"city\": \"Cuernavaca\",\n \"state\": \"Morelos\",\n \"postal_code\": \"62000\",\n \"country_code\": \"484\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"d1fb257a-f899-4e1b-8156-a24e75282f30\"\n },\n \"system_timestamp\": \"2025-10-03 13:34:46\",\n \"rtoken\": \"511028a9-3bf2-45b1-a365-a94cb58efcfd\"\n}\n"}}},"application/xml":{"examples":{"response":{"value":"\n \n 0\n Success\n 0.464\n \n 524630XXXXXX0810\n 2030-02-04\n 123\n N\n 2467493\n \n 999127602949\n Jordi\n \n Cardona\n \n \n f4b2a8e9-91cf-4e6a-8b4f-3d2d8f0d2c17\n \n N\n f4b2a8e9-91cf-4e6a-8b4f-3d2d8f0d2c17\n 2025-02-04\n 2025-02-04\n 2030-02-04\n standard\n 6552\n \n \n Unfrozen\n \n \n \n 0\n \n \n \n \n \n \n \n Physical\n Debit\n Calle Reforma 128\n Colonia Centro\n Cuernavaca\n Morelos\n 62000\n 484\n \n \n \n \n d1fb257a-f899-4e1b-8156-a24e75282f30\n \n 2025-10-03 13:34:46\n 511028a9-3bf2-45b1-a365-a94cb58efcfd\n \n"}}}},"description":""}},"operationId":"post_getcard"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getAccessToken":{"post":{"summary":"Get Access Token","description":"Use the Get Access Token endpoint to retrieve an access token for a card, account, or customer record. The expiry in seconds (default: 300) and usage count (default: 3) for the access token are configurable using the TSECV (seconds) and TUSEC (usage) parameters.\n\nWhen `type: 0` always use <> for `accountNo`.\n\nUse this endpoint to send a customer a link to a one-time view of a dynamically generated image of a virtual card via HTTP, for example, or for other purposes as appropriate.\n\nConsult Digital card images in the *Retrieving Card Information* guide for more information. For other uses contact SoFi Tech Solutions.","parameters":[],"tags":["Accounts and Cards"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <>, <> or <> of the account.\nPattern: PAN, PRN, or CAD\nExample: `\"074103447228\"`","example":"074103447228"},"type":{"type":"integer","format":"int32","enum":[0,1,2],"description":"Type of access token to retrieve:\n* `0` — Card\n* `1` — Account\n* `2` — Customer\n\nPattern: Integer\nExample: `2`","example":2}},"required":["accountNo","transactionId","type","apiLogin","apiTransKey","providerId"]}}}},"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"token":{"type":"string","description":"A token that is used to authenticate a HTTP post for sensitive data, such as PAN or a PIN"},"expires":{"type":"string","format":"date-time","description":"The date and time a token expires"}},"required":["expires","token"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.036,\n \"response_data\": {\n \"token\": \"hpSVyayQScHmhJS6_MVXT1WlsFRQoDJrRu_fi_JlX2Jo2dgg5p\",\n \"expires\": \"2025-07-13 10:47:53\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"MRE8WHE7S8YXTURF1N0W\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:42:53\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.052\n \n h05Ou_9w9Wcw2zme61bau0eZHF6axKWt52bxSH7p8x_Mze1Hbg\n 2025-07-13 12:40:46\n \n \n \n \n 1NGSVG6WJS5AO86CJR1F\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:35:46\n"}}}},"description":""}},"operationId":"post_getaccesstoken"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/addCard":{"post":{"summary":"Add Card","description":"Use the Add Card endpoint to add a new card (<> and <>) to an existing <>. Cards that are created with this endpoint are active upon creation, and the account status is updated to the second position of XAACT. SoFi Tech Solutions recommends that you have only one active card per PRN. As needed, ensure that any previous card has been marked lost, stolen, canceled, or any status but `N`.\n\nDo not use this endpoint to create multiple spending cards that share a central balance. For that use case, SoFi Tech Solutions recommends Real-Time Funding or Corporate Credit for large numbers of cards, or for small numbers of cards you can create one primary and multiple secondary accounts that share a balance.\n\nUse this endpoint in scenarios such as these:\n- Replacing a virtual card that is lost, stolen, or expired\n- Adding another virtual card to a PRN\n- Replacing an instant-issue card at a storefront (for card programs with a retail integration)\n- Replacing a personalized card\n","parameters":[],"tags":["Accounts and Cards"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account. Do not use the <>.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"prodId":{"type":"integer","format":"int32","minimum":1,"description":"Product ID of the card in `accountNo`.\nPattern: Integer\nExample: `\"501\"`","example":"501"},"newAccountNo":{"type":"string","nullable":true,"pattern":"^(\\d{12}|\\d{16})$","description":"The <>, <> or package ID of the instant-issue card to add. Pass this parameter only for instant-issue cards.\nPattern: PAN or PRN or Package ID\nExample: `\"123456789012\"`","example":"123456789012"},"creditLimit":{"type":"number","nullable":true,"minimum":0,"description":"Credit limit for card-based spending control. This is available only for credit programs.\nPattern: Monetary amount greater than 0.\nExample: `500.25`","example":500.25},"singleUse":{"type":"string","default":"N","enum":["Y","N"],"description":"Spending control to limit the card to one purchase transaction. This is available only for credit programs.\nPattern: String\nExample: `\"Y\"`","example":"Y"}},"required":["accountNo","prodId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"pmt_ref_no":{"type":"string","description":"A system-generated account number"},"product_id":{"type":"string","description":"System-generated integer"},"galileo_account_number":{"type":"string","description":"System-generated integer account number, also known as balance ID"},"card_id":{"type":"string","description":"An ID used for the card"}},"required":["card_id","galileo_account_number","pmt_ref_no","product_id"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.159,\n \"response_data\": {\n \"pmt_ref_no\": \"001109457018\",\n \"product_id\": \"88\",\n \"galileo_account_number\": \"462980\",\n \"card_id\": \"850341\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"ILJ61R9YKK5NYOCMTSPK\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:42:50\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.159\n \n 001104890593\n 88\n 386957\n 850574\n \n \n \n \n TICLSZ00BW9DFGXR3DI2\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:35:49\n"}}}},"description":""}},"operationId":"post_addcard"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/createProvisioningRequest":{"post":{"description":"Use the Create Provisioning Request endpoint to push-provision a virtual card to a mobile wallet. This endpoint is part of a multiple-step integration that must be completed with each mobile wallet partner. Consult the Creating a Provisioning Request guide for instructions on using this endpoint.","operationId":"post_createprovisioningrequest","parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"accountNo":{"description":"The <>, <> or <> of the account. For card-specific endpoints such as this one, the CAD is preferred. Do not use the PRN if more than one card has ever been associated with this account.\nPattern: PAN, PRN, or CAD\nExample: `\"074103447228\"`","example":"074103447228","maxLength":18,"pattern":"^$|^([0-9]+)$","type":"string"},"apiLogin":{"description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999","type":"string"},"apiTransKey":{"description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g","type":"string"},"cert1":{"description":"The leaf certificate returned by the wallet provider that was signed using `cert2`. Should be the hexlified (case insensitive) binary data of the certificate. See Certificate formatting for more information. Required for Apple Pay; not required for Samsung Pay or Google Pay.","format":"hexadecimal digits","nullable":true,"type":"string"},"cert2":{"description":"The subordinate certificate returned by the wallet provider that was signed using the wallet provider’s Certificate Authority (CA) certificate. Should be the hexlified (case insensitive) binary data of the certificate. See Certificate formatting for more information. Required for Apple Pay; not required for Samsung Pay or Google Pay.","format":"hexadecimal digits","nullable":true,"type":"string"},"clientDeviceID":{"description":"Value returned by Google Pay or Samsung Pay for use with Visa. **Required** for Visa + Samsung Pay or Google Pay; not required for Visa + Apple Pay.","nullable":true,"type":"string"},"clientWalletAccountID":{"description":"Value returned by Google Pay or Samsung Pay for use with Visa. **Required** for Visa + Samsung Pay or Google Pay; not required for Visa + Apple Pay.","nullable":true,"type":"string"},"nonce":{"description":"The hexlified (case insensitive) nonce value returned by Apple Pay. **Required** for Apple Pay; not required for Google Pay or Samsung Pay.\nPattern: 8 character nonce value\nExample: `\"9c023092\"`","example":"9c023092","format":"hexadecimal digits","nullable":true,"type":"string"},"nonceSignature":{"description":"The hexlified (case insensitive) nonce signature value returned by Apple Pay. **Required** for Apple Pay (not required for web push provisioning); not required for Google Pay or Samsung Pay.\nPattern: Nonce signature value\nExample: `\"4082f883ae62...\"`","example":"4082f883ae62...","format":"hexadecimal digits","nullable":true,"type":"string"},"provisioningSource":{"description":"The source of the provisioning request. Accepted values: `\"in_app\"`, `\"web\"`. Defaults to `\"in_app\"` in the provisioner when not provided.\nExample: `\"web\"`","enum":["in_app","web"],"example":"in_app","nullable":true,"type":"string"},"transactionId":{"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000","maxLength":60,"minLength":1,"type":"string"},"walletProvider":{"description":"The type of wallet to provision:\n* `1` — Apple Pay\n* `2` — Google Pay \n* `3` — Samsung Pay\n* `4` — Apple Pay Web\nPattern: One digit\nExample: `2`","enum":[1,2,3,4,5],"example":2,"type":"integer"}},"required":["accountNo","transactionId","walletProvider","apiLogin","apiTransKey","providerId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"echo":{"anyOf":[{"additionalProperties":false,"properties":{"provider_timestamp":{"description":"Store a related timestamp for reporting and troubleshooting purposes","format":"date-time","nullable":true,"type":"string"},"provider_transaction_id":{"description":"Secondary transaction identifier (generated by a provider)","nullable":true,"type":"string"},"transaction_id":{"description":"An ID that represents an API transaction","nullable":true,"type":"string"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure that contains transaction ID information"},"errors":{"description":"A list of errors generated while the request was processed","items":{"type":"string"},"type":"array"},"processing_time":{"description":"The time elapsed in processing the transaction","nullable":true,"type":"number"},"response_data":{"anyOf":[{"additionalProperties":false,"properties":{"provisioning_request_data":{"description":"The provisioning request data to be directly sent to the wallet-provider","additionalProperties":false,"properties":{"activationData":{"description":"Apple Pay only. The request's activation data. This field is always Base64-encoded when PPALE is set to Y; otherwise, it could be Base64-encoded or hex-encoded.","type":"string"},"encryptedPassData":{"description":"Apple Pay only. An encrypted JSON file containing the sensitive information needed to add a card to a wallet. This field is always Base64-encoded when PPALE is set to Y; otherwise, it could be Base64-encoded or hex-encoded.","type":"string"},"ephemeralPublicKey":{"description":"Apple Pay only. A generated key that is combined with a private key. This field is always Base64-encoded when PPALE is set to Y; otherwise, it could be Base64-encoded or hex-encoded.","type":"string"},"googleOpaquePaymentCard":{"description":"Google Pay UPP only. A standard Base64-encoded opaque string (the signed/encrypted Google OPC). Present when `googleOpaquePaymentCardRequested=true` and the Google OPC was minted successfully; otherwise null.","nullable":true,"type":"string"},"opaquePaymentCard":{"description":"Google Pay only. A Base64-encoded or Base64url-encoded opaque string. For Google Pay UPP (`walletProvider=5`), nullable — absent when `tspOpaquePaymentCardRequested=false`.","nullable":true,"type":"string"},"payload":{"description":"Samsung Pay only. A Base64-encoded or Base64url-encoded opaque string.","type":"string"}},"type":"object"}},"required":["provisioning_request_data"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure for the response data. It can be empty but usually will contain information."},"rtoken":{"description":"A system-generated ID used for tracking","nullable":true,"type":"string"},"status":{"description":"The condition of a process or response","nullable":true,"type":"string"},"status_code":{"description":"The response status code. May return a string for some statuses.","nullable":true,"type":"integer"},"system_timestamp":{"description":"A system generated timestamp","format":"date-time","nullable":true,"type":"string"}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"],"type":"object"}}},"description":"Successful response"}},"summary":"Create Provisioning Request","tags":["Accounts and Cards"]},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/createSingleUseVirtualCard":{"post":{"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","x-minimum":"1","x-maximum":"60","description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"primaryAccountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of an existing account held by the customer receiving the single use virtual card\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"prodId":{"type":"integer","minimum":0,"maximum":100000000,"description":"A unique product identifier from SoFi Tech Solutions.\nPattern: Max 9 digits\nExample: `501`","example":501},"creditLimit":{"type":"number","minimum":0,"description":"Credit limit for the single-use virtual card. Minimum value is 50.00.\nPattern: Decimal number (14, 2)\nExample: `500.25`","example":500.25}},"required":["creditLimit","primaryAccountNo","prodId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"pmt_ref_no":{"type":"string","description":"The PRN or PAN of the new account."},"card_id":{"type":"string","description":"Unique identifier for the card associated with the account."}},"required":["card_id","pmt_ref_no"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.298,\n \"response_data\": [\n {\n \"pmt_ref_no\": \"001109455145\",\n \"card_id\": \"123\"\n }\n ],\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"O3S5VRKXCO5FNUMSXTIC\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:36:54\"\n}\n"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 2025-07-13 10:36:54\n \n 001109455145\n \n 0.0.298\n \n O3S5VRKXCO5FNUMSXTIC\n \n \n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n\n"}}}},"description":""}},"summary":"Create Single-Use Virtual Card","tags":["Accounts and Cards"],"description":"Use the Create Single-Use Virtual Card endpoint to create a single-use virtual card for a BNPL customer. To use this endpoint with a product, the SUVC product parameter must be set to Y, indicating that the product is a single-use virtual card.","operationId":"post_createsingleusevirtualcard"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/ping":{"post":{"parameters":[],"summary":"Ping","tags":["Miscellaneous"],"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","type":"object","properties":{}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.022,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"A43ZQ5ZMR4XALONBW1G3\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:48:07\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.049\n \n \n \n \n BE8Z7F78YSAS0EA1TBA8\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:42:45\n"}}}},"description":""}},"description":"Use the Ping endpoint to test API connectivity and permissions. Ping does not perform any functions on the system. Some use cases for Ping are:\n* Testing access from an automated monitoring service\n* Integrating with an API call to confirm assumptions and validate access","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"}},"required":["transactionId","apiLogin","apiTransKey","providerId"]}}}},"operationId":"post_ping"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/createSimulatedCardAuth":{"post":{"parameters":[],"tags":["Transaction Simulation"],"description":"Use the Create Simulated Card Authorization endpoint to simulate a card authorization in the <> environment. This endpoint creates but does not settle a card authorization for the account and returns a response code and its description with the `auth_id`. \n- Capture the `auth_id` to settle the transaction with Create Simulated Card Settlement.\n- For instructions on using this endpoint see Simulating Card Transactions.\n\n[block:callout]\n\n{\n\"type\": \"warning\",\n\"title\": \"Warning\",\n\"body\": \"This endpoint does not support XML responses. If you pass `response-content-type: xml`, it will be ignored.\"\n}\n[/block]\n\n[block:callout]\n\n{\n\"type\": \"warning\",\n\"title\": \"Warning\",\n\"body\": \"Do not use this endpoint in <>.\"\n}\n[/block]\n\n","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A Galileo-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"auth_response_code":{"type":"string","description":"A code used to give the status of the simulated auth"},"auth_response_description":{"type":"string","description":"A description of the authorization response"},"auth_id":{"type":"string","description":"An ID associated with the simulated auth"}},"required":["auth_id","auth_response_code","auth_response_description"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"system_timestamp\": \"2025-07-16 12:11:03\",\n \"response_data\": {\n \"auth_response_code\": \"00\",\n \"auth_response_description\": \"Success\",\n \"auth_id\": 937\n },\n \"processing_time\": 1.095,\n \"echo\": {\n \"transaction_id\": \"ae72d29061b14bf09c2c863c0affa86d\",\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": \"None\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\"\n}"}}}},"description":""}},"summary":"Create Simulated Card Authorization","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by Galileo.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`"},"apiTransKey":{"type":"string","description":"Web service password, as provided by Galileo.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`"},"providerId":{"type":"integer","description":"Galileo-issued provider identifier.\nPattern: Max 10 digits\nExample: `9999`"},"transactionId":{"type":"integer","description":"A unique provider-generated ID to identify this API call. A UUID is preferred.\nPattern: 60 characters or less\nExample: `\"9845dk-39fdk3fj3-4483483478\"`"},"accountNo":{"type":"string","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`"},"amount":{"type":"number","description":"The amount of the transaction in the currency at the point of sale.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`"},"association":{"type":"string","description":"Specifies which card network to simulate: `visa` (Visa), `mc_auth` (Mastercard Credit).\nPattern: string\nExample: `\"visa\"`"},"merchantName":{"type":"string","description":"Simulated merchant name. Pass 40 characters for the complete string or pass up to 22 characters and the simulator will add 18 characters of a simulated address. For settlements, this parameter is **required** when `authId` is not populated.\nPattern: Max 40 alphanumeric characters\nExample: `\"Fred Jones Bagels\"`"},"acquirerId":{"type":"string","description":"Simulated acquirer ID. If this value is not passed, the simulator inserts a random 6-digit number.\nPattern: 6-digit number\nExample: `437723`"},"terminalId":{"type":"string","description":"Simulated terminal ID. If this value is not passed, the simulator inserts a random 8-digit number.\nPattern: 8-digit number\nExample: `57395783`"},"merchantId":{"type":"string","description":"Simulated merchant ID. If this value is not passed, the simulator inserts a random 15-character alphanumeric string.\nPattern: Max 15 alphanumeric characters\nExample: `\"asdf45sdf6sd3d0a\"`"},"currencyCode":{"type":"string","description":"The currency code for `amount`. Use ISO 4217 numeric currency codes. This parameter is required when using this endpoint outside the United States.\nPattern: 3 digits\nExample: `\"840\"`"},"settleAmount":{"type":"number","description":"The amount to be transferred from merchant to issuer in the settlement currency. Required when `currencyCode` differs from the account currency, or when `specialFunctions: make_multicurrency`.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`"},"settleCurrencyCode":{"type":"string","description":"The currency code for `settleAmount`. Use ISO 4217 numeric currency codes. Required when `currencyCode` differs from the account currency, or when `specialFunctions: make_multicurrency`.\nPattern: 3 digits\nExample: `\"124\"`"},"cardBillingAmount":{"type":"number","description":"The amount that will be posted to the cardholder account in the currency of the account. Required when `currencyCode` differs from the account currency, or when `specialFunctions: make_multicurrency`.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`"},"cardBillingCurrencyCode":{"type":"string","description":"The currency code for `cardBillingAmount`. Use ISO 4217 numeric currency codes. Required when `currencyCode` differs from the account currency, or when `specialFunctions: make_multicurrency`.\nPattern: 3 digits\nExample: `484`"},"mcc":{"type":"string","description":"ISO 18245 merchant category code.\nPattern: 4 digits\nExample: `3408`"},"originalAuthId":{"type":"string","description":"The `auth_id` of the previous authorization in a series, such as with a completion, reversal or incremental authorization. Required when `transType` is `3`, `4`, `5` or `6` (Visa) or `3` (Mastercard) or `4`, `5`, `6` (Star).\nPattern: Numerals\nExample: `30582`"},"specialFunctions":{"type":"string","description":"Additional function to add to the simulated transaction. See the Special Functions enumeration for valid values. \nPattern: Max 100 characters\nExample `\"add_cashback\"`"},"posEntryMode":{"type":"string","description":"The first two characters of DE022. Specifies how the PAN was entered, such as magnetic stripe, EMV chip or contactless. See DE022 Codes for possible values. Valid only when `association: visa`.\nPattern: 2 characters\nExample: `01`"},"requesterId":{"type":"string","description":"An identifier for the entity that makes a tokenization request. Required when `specialFunctions: make_tokenized`.\nPattern: Numerals\nExample: `3030303`"},"walletId":{"type":"string","description":"Identifier for the mobile wallet that contains the card that was used for the transaction. Required when `association: mc_auth` and `specialFunctions: make_tokenized`.\nPattern: Numerals\nExample: `474747474`"},"latitudeAndLongitude":{"type":"string","description":"The latitude and longitude of the point of sale. Valid only when `association: visa` and `transType: 17`. Default: `40.76078/-111.89105` (Salt Lake City, UT)\nPattern: 99.99999/-99.99999\nExample: `\"40.76078/-111.89105\"`"},"partialAmount":{"type":"number","description":"Amount of a partial authorization. Valid only when `association: mc_auth` and `specialFunctions: make_partial_reversal`. \nPattern: Integer or decimal amount\nExample: `100.00`, `100`, or `100.73`"},"partialForeignAmount":{"type":"number","description":"Amount of a partial authorization when the point of sale is a different country than the account. Valid only when `association: mc_auth` and `specialFunctions: make_partial_reversal`.\nPattern: Integer or decimal amount\nExample: `100.00`, `100`, or `100.73`"},"cashbackAmount":{"type":"number","description":"Amount in `localAmt` that is provided in cash. Valid only when `association: mc_auth` and `specialFunctions: make_cashback`. Debit accounts only.\nPattern: Integer or decimal amount\nExample: `100.00`, `100`, or `100.73`"},"cashAdvanceAmount":{"type":"number","description":"Amount in `localAmt` that is provided in cash. Valid only when `association: mc_auth` and `specialFunctions: make_cashback`. Credit accounts only.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`"},"pin":{"type":"string","description":"To include the PIN that is already set for the card, leave this value blank and pass `specialFunctions: add_pin` (Visa) or `specialFunctions: make_debit` (Mastercard). Pass a value for this parameter to use that value in the request and also to change the PIN for the card.\nPattern: 4 digits\nExample: `4395`"},"transType":{"type":"integer","description":"The type of transaction to simulate. See the Simulated Transaction Types enumeration for valid values.\nPattern: 1 or 2 digits\nExample: `3`"}},"required":["providerId","transactionId","accountNo","amount","association","merchantName","apiLogin","apiTransKey"]}}}},"operationId":"post_createsimulatedcardauth"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/createSimulatedCardSettle":{"post":{"parameters":[],"tags":["Transaction Simulation"],"description":"Use the Create Simulated Card Settlement endpoint to settle a simulated card authorization in the <> environment. First, create a simulated authorization using the Create Simulated Card Authorization endpoint, and then use this endpoint to settle it. \n- If `authId` is not populated, then `merchantName` is **required**. Populate `merchantName` but not `authId` to simulate a force-posted transaction.\n- For instructions on using this endpoint see Simulating Card Transactions.\n\n[block:callout]\n\n{\n\"type\": \"warning\",\n\"title\": \"Warning\",\n\"body\": \"This endpoint does not support XML responses. If you pass `response-content-type: xml`, it will be ignored.\"\n}\n[/block]\n\n[block:callout]\n\n{\n\"type\": \"warning\",\n\"title\": \"Warning\",\n\"body\": \"Do not use this endpoint in <>.\"\n}\n[/block]\n\n","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A Galileo-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"settle_response_code":{"type":"string","description":"A code used to give the status of the simulated auth settlement"},"settle_response_description":{"type":"string","description":"A description of the settlement response"},"settle_dtl":{"type":"string","description":"An ID associated with the simulated settlement"}},"required":["settle_dtl","settle_response_code","settle_response_description"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"system_timestamp\": \"2025-07-16 12:16:11\",\n \"response_data\": {\n \"settle_response_code\": \"00\",\n \"settle_response_description\": \"Success\",\n \"settle_dtl_id\": 408\n },\n \"processing_time\": 1.082,\n \"echo\": {\n \"transaction_id\": \"470cfabf70ca4731970470feaf4757d8\",\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": \"None\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\"\n}"}}}},"description":""}},"summary":"Create Simulated Card Settlement","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by Galileo.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`"},"apiTransKey":{"type":"string","description":"Web service password, as provided by Galileo.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`"},"providerId":{"type":"integer","description":"Galileo-issued provider identifier.\nPattern: Max 10 digits\nExample: `9999`"},"transactionId":{"type":"integer","description":"A unique provider-generated ID to identify this API call. A UUID is preferred.\nPattern: 60 characters or less\nExample: `\"9845dk-39fdk3fj3-4483483478\"`"},"accountNo":{"type":"string","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`"},"amount":{"type":"number","description":"The amount of the transaction in the currency at the point of sale.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`"},"association":{"type":"string","description":"Specifies which card network to simulate: `visa` (Visa), `mc_auth` (Mastercard Credit).\nPattern: string\nExample: `\"visa\"`"},"merchantName":{"type":"string","description":"Simulated merchant name. Pass 40 characters for the complete string or pass up to 22 characters and the simulator will add 18 characters of a simulated address. For settlements, this parameter is **required** when `authId` is not populated.\nPattern: Max 40 alphanumeric characters\nExample: `\"Fred Jones Bagels\"`"},"currencyCode":{"type":"string","description":"The currency code for `amount`. Use ISO 4217 numeric currency codes. This parameter is required when using this endpoint outside the United States.\nPattern: 3 digits\nExample: `\"840\"`"},"settleAmount":{"type":"number","description":"The amount to be transferred from merchant to issuer in the settlement currency. Required when `currencyCode` differs from the account currency, or when `specialFunctions: make_multicurrency`.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`"},"settleCurrencyCode":{"type":"string","description":"The currency code for `settleAmount`. Use ISO 4217 numeric currency codes. Required when `currencyCode` differs from the account currency, or when `specialFunctions: make_multicurrency`.\nPattern: 3 digits\nExample: `\"124\"`"},"cardBillingAmount":{"type":"number","description":"The amount that will be posted to the cardholder account in the currency of the account. Required when `currencyCode` differs from the account currency, or when `specialFunctions: make_multicurrency`.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`"},"cardBillingCurrencyCode":{"type":"string","description":"The currency code for `cardBillingAmount`. Use ISO 4217 numeric currency codes. Required when `currencyCode` differs from the account currency, or when `specialFunctions: make_multicurrency`.\nPattern: 3 digits\nExample: `484`"},"authId":{"type":"string","description":"The authorization ID (`auth_id`) as returned by the Create Simulated Card Authorization endpoint. If this parameter is not populated then `merchantName` is **required**.\nPattern: Positive integer\nExample: `58344373`"}},"required":["providerId","transactionId","accountNo","amount","association","merchantName","apiLogin","apiTransKey"]}}}},"operationId":"post_createsimulatedcardsettle"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/createAccountTransfer":{"post":{"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"old_balance":{"type":"number","format":"float","description":"The old balance on the source account"},"new_balance":{"type":"number","format":"float","description":"The new balance on the source account"},"adjustment_trans_id":{"type":"number","description":"The transaction ID for the debit"},"transfer_account_id":{"type":"string","description":"The recipient account of the transfer"},"sender_fee_amount":{"type":"number","format":"float","description":"The C2C fee applied to the transfer, if any"},"payment_trans_id":{"type":"number","description":"The transaction ID for the credit"},"transfer_to_account":{"type":"object","properties":{"old_balance":{"type":"number","format":"float","description":"The old balance on the recipient account"},"new_balance":{"type":"number","format":"float","description":"The new balance on the recipient account"}},"required":["new_balance","old_balance"]}},"required":["adjustment_trans_id","new_balance","old_balance","payment_trans_id","sender_fee_amount","transfer_account_id","transfer_to_account"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.527,\n \"response_data\": {\n \"old_balance\": 10,\n \"new_balance\": 8.75,\n \"adjustment_trans_id\": 57906,\n \"transfer_account_id\": 0,\n \"sender_fee_amount\": 0,\n \"payment_trans_id\": 4161926,\n \"transfer_to_account\": {\n \"old_balance\": 1193.45,\n \"new_balance\": 1194.7\n }\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"JJ04THYA130791J8KS3R\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:47:17\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.505\n \n 95.05\n 93.8\n 57931\n 0\n 0\n 4162164\n \n 1209.95\n 1211.2\n \n \n \n \n \n UBT3LMWWF5QBQ10RZQA9\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:42:12\n"}}}},"description":""}},"parameters":[],"summary":"Create Account Transfer","description":"Use the Create Account Transfer endpoint to move funds between accounts in the same program. You can combine a fee with the payment or adjustment, depending on what transaction types you have set up with SoFi Tech Solutions. The accounts can belong to the same customer or different customers. If the accounts are in different programs, verify that the program parameters permit transferring funds between the programs.\n\nPass the sending account in the `accountNo` parameter and the receiving account in the `transferToAccountNo` parameter. The receiving account should be in `status: N` (active) and the active flag set to `Y`.\n\nTo permit this endpoint to drive the sending account negative, set the ALWNB parameter on the sending product.\n\nConsult the Creating an Internal Transfer guide for instructions on using this endpoint.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the sending account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"amount":{"type":"number","format":"float","minimum":0.01,"description":"Currency amount as a whole or decimal amount. \nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`","example":25.5},"transferToAccountNo":{"type":"string","pattern":"^[0-9]{12}$|^[0-9]{16}$","description":"The <> or <> of the receiving account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"message":{"type":"string","nullable":true,"minLength":1,"maxLength":2000,"description":"A message for the transfer recipient. The C2DSC provider parameter must be set to `1` to populate this parameter. If you do not populate this parameter, it defaults to the value in the BMNAM product parameter. The system truncates this field to 80 characters.\nPattern: Max 2000 Windows-1252 characters\nExample: `\"Thanks again for lunch!\"`","example":"Thanks again for lunch!"},"senderMessage":{"type":"string","nullable":true,"minLength":1,"maxLength":80,"description":"A message for the transfer sender. The C2DSC provider parameter must be set to populate this parameter. If you do not populate this parameter, it defaults to the value in `message`. \nPattern: Max 80 Windows-1252 characters\nExample: `\"Thanks again for lunch!\"`","example":"Thanks again for lunch!"},"type":{"type":"string","nullable":true,"pattern":"^([a-zA-Z0-9]){3}$","description":"Transaction type for the transfer. Use the values provided by SoFi Tech Solutions for your program.\nPattern: Max 3 alphanumeric characters, case-sensitive\nExample: `\"MRM\"`","example":"MRM"}},"required":["accountNo","amount","transactionId","transferToAccountNo","apiLogin","apiTransKey","providerId"]}}}},"tags":["Transactions"],"operationId":"post_createaccounttransfer"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getDepositHistory":{"post":{"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"deposit_count":{"type":"integer","format":"int32","description":"The number of deposits in the response"},"page":{"type":"integer","format":"int32","description":"The page number to be retrieved in the context of recordset paging"},"total_record_count":{"type":"integer","format":"int32","description":"Total number of deposit records returned"},"number_of_pages":{"type":"integer","format":"int32","description":"Total number of pages"},"start_date":{"type":"string","format":"date","description":"The start date for deposit records"},"end_date":{"type":"string","format":"date","description":"The end date for deposit records"},"deposits":{"type":"array","items":{"type":"object","properties":{"amt":{"type":"string","nullable":true,"description":"The amount of the deposit"},"in_ts":{"type":"string","format":"date-time","description":"Timestamp for the initial creation of the record"},"effective_dt":{"type":"string","format":"date-time","nullable":true,"description":"Date when the ACH payment posts"},"name":{"type":"string","nullable":true,"description":"The name of the account receiving the deposit"},"efname":{"type":"string","nullable":true,"description":"Encrypted cardholder first name"},"elname":{"type":"string","nullable":true,"description":"Encrypted cardholder last name"},"xid":{"type":"string","nullable":true,"description":"An account ID that can be used instead of the PAN"},"prog_id":{"type":"string","nullable":true,"description":"Identifier for the program associated with the account"},"batch_hdr":{"type":"string","nullable":true,"description":"A record of a batch of transactions"},"company_entry_description":{"type":"string","nullable":true,"description":"Value of Company Entry Description from the Company/Batch Header Record in ach file"},"company_identification":{"type":"string","nullable":true,"description":"Value of Company Identification from the Company/Batch Header Record in ach file"},"dest_acct_no":{"type":"string","nullable":true,"description":"The destination account for a pending deposit"},"source_inst_id":{"type":"string","nullable":true,"description":"An ID (usually a bank routing number) for the institution that originated the deposit"},"source_inst_name":{"type":"string","nullable":true,"description":"The name of the institution that originated the deposit"},"source_acct_no":{"type":"string","nullable":true,"description":"An account number of the institution that originated the deposit"},"status":{"type":"string","nullable":true,"description":"The status of the deposit. See Deposit Status Codes."},"trans_type":{"type":"string","nullable":true,"description":"Transaction type"},"addenda_rec":{"type":"string","nullable":true,"description":"Supplemental information to identify a deposit"},"ach_trans_id":{"type":"string","description":"A unique ID for an ACH transaction"},"pmt_ref_no":{"type":"string","nullable":true,"description":"Payment reference number."},"ach_category":{"type":"string","nullable":true,"description":"Transaction ACH category"},"ach_subcategory":{"type":"string","nullable":true,"description":"Transaction ACH subcategory"},"trans_ts":{"type":"string","format":"date-time","nullable":true,"description":"Original settlement date"},"actual_settl_dt":{"type":"string","format":"date-time","nullable":true,"description":"Actual settlement date"},"ach_early_days_used":{"type":"number","nullable":true,"description":"Number of Early Days Used"},"categories":{"type":"array","items":{"description":"Category information for an ACH request to move funds into or out of the customer's account","type":"object","properties":{"ach_source_id":{"type":"string","nullable":true,"description":"An identifier for the <>"},"category_code":{"type":"string","description":"Category code for the deposit. See Deposit Category Codes for valid values."},"description":{"type":"string","description":"Description of the record"},"last_updated":{"type":"string","description":"Indicates when the `source_status` was last updated"},"last_updated_by":{"type":"string","nullable":true,"description":"Indicates who last updated the `source_status`"},"source_status":{"type":"string","description":"The source status for the ACH request. Possible values are `APPROVE`, `WATCH`, or `DECLINE`"},"status":{"type":"string","nullable":true,"description":"The deposit status. See Deposit Status Codes for possible values."}},"required":["ach_source_id","category_code","description"]}}},"required":["ach_trans_id","amt","effective_dt","in_ts","name","prog_id","source_inst_id","source_inst_name","status","trans_type"]}}},"required":["deposit_count","deposits","end_date","number_of_pages","page","start_date","total_record_count"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.478,\n \"response_data\": {\n \"deposit_count\": 1,\n \"page\": 1,\n \"total_record_count\": 1,\n \"number_of_pages\": 1,\n \"start_date\": \"2025-07-10\",\n \"end_date\": \"2025-07-15\",\n \"deposits\": [\n {\n \"amt\": \"100\",\n \"in_ts\": \"2025-07-15 14:27:05\",\n \"effective_dt\": \"2025-07-15 14:27:05\",\n \"name\": null,\n \"xid\": \"5461535\",\n \"prog_id\": \"615\",\n \"batch_hdr\": null,\n \"dest_acct_no\": \"005461535202\",\n \"source_inst_id\": null,\n \"source_inst_name\": null,\n \"status\": \"U\",\n \"trans_type\": \"DD\",\n \"addenda_rec\": \"705 Bellco00013751545\",\n \"ach_trans_id\": \"75001795\",\n \"efname\": \"MDAxNiW00jbNDJzkMnIgw5F66EIK\",\n \"elname\": \"MDAxNgYDOoHXPekcFNW6fCKnJUkK\",\n \"pmt_ref_no\": \"005461535202\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"2e8a85fa-b062-4bd9-a658-0670bfe5e395\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 14:27:07\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.034\n \n 1\n 1\n 1\n 1\n 2025-07-10\n 2025-07-15\n \n \n 100\n 2025-07-15 14:27:05\n 2025-07-15 14:27:05\n \n 5461535\n 615\n \n 005461535202\n \n \n U\n DD\n 705 Bellco00013751545\n 75001795\n MDAxNiW00jbNDJzkMnIgw5F66EIK\n MDAxNgYDOoHXPekcFNW6fCKnJUkK\n 005461535202\n \n \n \n \n \n \n 40160d62-4ee0-4488-ba7d-500636c123f2\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 14:27:08\n"}}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"startDate":{"type":"string","format":"date","description":"The beginning date for the date range, either a date or a date-time.`\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"endDate":{"type":"string","format":"date","description":"The end date for the date range, either a date or a date-time. Must be equal to or later than `startDate`. Max 1098 days (~3 years) after `startDate`. \nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"recordCnt":{"type":"integer","format":"int32","nullable":true,"minimum":1,"maximum":99999,"description":"The maximum number of records per page to be returned.\nPattern: Integer\nExample: `100`","example":100},"page":{"type":"integer","format":"int32","default":1,"description":"The number of the page to retrieve.\nPattern: Integer value of `1` or greater\nExample: `3`","example":3}},"required":["endDate","startDate","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Transactions"],"summary":"Get Deposit History","parameters":[],"description":"Use the Get Deposit History endpoint to retrieve deposit history for either your entire program or for a specified customer. Omit the `accountNo` parameter to get the history for your entire program.\n\nSee Record-Set Pagination for instructions on using the paging parameters.","operationId":"post_getdeposithistory"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getAllTransHistory":{"post":{"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"transaction_count":{"type":"integer","format":"int32","description":"The number of transactions listed in the response"},"page":{"type":"integer","format":"int32","description":"The page number to be retrieved for record-set paging"},"total_record_count":{"type":"integer","format":"int32","description":"Number of records in the accounts-list display"},"number_of_pages":{"type":"integer","format":"int32","description":"Total number of pages in the accounts-list display"},"start_date":{"type":"string","format":"date-time","description":"Start date of the transactions"},"end_date":{"type":"string","format":"date-time","description":"End date of the transactions"},"sums":{"description":"sums","type":"object","properties":{"unsettled":{"type":"number","format":"float","description":"The sum of transactions that have not been settled"},"settled":{"type":"number","format":"float","description":"The sum of authorizations that have been settled"},"adjustment":{"type":"number","format":"float","description":"The sum of adjustments (`act_type: AD`)"},"fee":{"type":"number","format":"float","description":"The sum of charges for a service (`act_type: FE`)"},"payment":{"type":"number","format":"float","description":"The sum of payments (`act_type: PM`)"}},"required":["adjustment","fee","payment","settled","unsettled"]},"transactions":{"type":"array","description":"List of transactions","items":{"type":"object","properties":{"act_id":{"type":"string","nullable":true,"description":"Transaction activity identifier used in the SoFi Tech Solutions system. This value is returned only because it is used to sort the transactions."},"is_savings":{"type":"boolean","description":"Specifies whether the transaction is made on a savings account."},"deny_code":{"type":"string","nullable":true,"description":"Two-digit code when an authorization request is denied."},"disputable":{"type":"boolean","description":"Specifies whether the transaction can be disputed."},"details":{"type":"string","description":"Description provided by the merchant about the transaction (DE043)."},"act_type":{"type":"string","description":"Activity type. See the Activity Type enumeration."},"act_type_description":{"type":"string","description":"Description of `act_type`. See the Activity Type enumeration."},"latest_incremental_id":{"type":"string","nullable":true,"description":"The `auth_id` of the previous authorization in an incremental sequence, if any. This field contains the same information as `original_auth_id` and is present only by request."},"original_incremental_id":{"type":"string","nullable":true,"description":"The `auth_id` of the first authorization in an incremental sequence, if any. This field is present only by request."},"post_ts":{"type":"string","format":"date-time","description":"The date and time when a transaction was posted to the account ledger, in system time."},"amt":{"type":"number","format":"float","description":"The transaction amount in the currency of the account. A negative amount debits funds from the account."},"source_id":{"type":"string","nullable":true,"description":"A system-generated integer that maps back to the original transaction, such as `auth_id`, `pmt_id`, or `adj_id`."},"type":{"type":"string","description":"The otype of the transaction. When the otype is a numeral and `act_type: SE`, the numeral is returned as a string. Other numerals are returned as integers with no leading zeros. Refer to transaction types for card-transaction values; for other transaction types, consult the otype list that SoFi Tech Solutions gave you."},"type_description":{"type":"string","nullable":true,"description":"The description of the transaction type."},"trans_code":{"type":"string","description":"A concatenation of the activity type (`act_type`) and transaction type (`type`)."},"arn":{"type":"string","nullable":true,"description":"Acquirer reference number. An identifier for the acquiring processor."},"merchant_id":{"type":"string","nullable":true,"description":"Network-assigned identifier for a merchant (DE042)."},"external_trans_id":{"type":"string","nullable":true,"description":"A user-supplied identifier for a transaction, if any."},"calculated_balance":{"type":"number","format":"float","description":"**[DEPRECATED]** This field is deprecated and may be removed in future versions. It currently contains the same value as `rolling_balance`. "},"rolling_balance":{"type":"number","format":"float","nullable":true,"description":"Available balance immediately after this transaction posts. If SoFi Tech Solutions is not the system of record, this value may not be accurate. For a new account with no transactions, this value is `null`."},"ach_trans_id":{"type":"string","nullable":true,"description":"A unique identifier for the ACH transaction, if applicable."},"auth_ts":{"type":"string","format":"date-time","nullable":true,"description":"The system time when a transaction was authorized."},"prior_id":{"type":"string","nullable":true,"description":"The `auth_id` of the previous transaction in the sequence, if any. Maps to `original_auth_id`."},"card_id":{"type":"string","nullable":true,"description":"A system-generated identifier for a card, which can be used instead of the PAN. Maps to `cad`."},"formatted_merchant_desc":{"type":"string","nullable":true,"description":"The same information as in the `details` field, with formatting."},"network_code":{"type":"string","nullable":true,"description":"A system-generated code to identify the subnetwork over which the transaction took place. Maps to `network_id`."},"auth_id":{"type":"string","nullable":true,"description":"A system-generated identifier for an authorization and its settlement."},"local_amt":{"type":"number","format":"float","nullable":true,"description":"Amount of the authorization in the currency at the point of sale. Unsigned. This amount does not include upcharges or program fees. (DE004)"},"local_curr_code":{"type":"string","nullable":true,"description":"Currency code for `local_amt` (DE049)."},"settle_amt":{"type":"number","format":"float","nullable":true,"description":"The transaction amount, in the settlement currency (DE005)"},"settle_curr_code":{"type":"string","nullable":true,"description":"Currency code for `settle_amt` (DE050)."},"billing_amt":{"type":"number","format":"float","nullable":true,"description":"The transaction amount, in the currency of the cardholder account (DE006) "},"billing_curr_code":{"type":"string","nullable":true,"description":"Currency code for `billing_amt` (DE051)."},"pmt_ref_no":{"type":"string","nullable":true,"description":"A system-generated number to identify the customer account. Maps to `PRN` and `prn`."},"mcc_code":{"type":"string","nullable":true,"description":"Category code for the merchant that initiated the transaction (DE018)."},"credit_ind":{"type":"string","nullable":true,"description":"Indicates whether a PIN was input at the point of sale. `Y` = No PIN was input. `N` = A PIN was input. `None` = Not a card transaction, or not processed as a card transaction."},"iac_tax":{"type":"number","format":"float","nullable":true,"description":"Impuesto al consumo. Colombian consumption tax. Required for the Mastercard Interchange Intracountry Calculation Program."},"iva_tax":{"type":"number","format":"float","nullable":true,"description":"Impuesto al valor agregado. Colombian value-added tax. Required for the Mastercard Interchange Intracountry Calculation Program."},"funding_account_prn":{"type":"string","nullable":true,"description":"The <> of the <> funding account"},"spending_account_prn":{"type":"string","nullable":true,"description":"The PRN of the RTF spending account"}},"required":["ach_trans_id","act_type","act_type_description","amt","arn","auth_id","auth_ts","billing_amt","billing_curr_code","calculated_balance","card_id","credit_ind","deny_code","details","disputable","external_trans_id","formatted_merchant_desc","is_savings","local_amt","local_curr_code","mcc_code","merchant_id","network_code","pmt_ref_no","post_ts","prior_id","settle_amt","settle_curr_code","source_id","trans_code","type","type_description"]}},"beginning_balance":{"type":"number","format":"float","description":"The available balance as of the `start_date`. "}},"required":["beginning_balance","end_date","number_of_pages","page","start_date","sums","total_record_count","transaction_count","transactions"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.577,\n \"response_data\": {\n \"transaction_count\": 15,\n \"page\": 1,\n \"total_record_count\": 15,\n \"number_of_pages\": 1,\n \"start_date\": \"2025-06-15 00:00:00\",\n \"end_date\": \"2025-07-16 23:59:59\",\n \"sums\": {\n \"unsettled\": 6.52,\n \"settled\": 23.55,\n \"adjustment\": 0,\n \"fee\": -1.57,\n \"payment\": 0\n },\n \"transactions\": [\n {\n \"is_savings\": true,\n \"deny_code\": null,\n \"disputable\": false,\n \"details\": \"Pending Payment\",\n \"act_type\": \"PE\",\n \"act_type_description\": \"Pending Payment\",\n \"post_ts\": \"2025-07-15 14:13:26\",\n \"amt\": 1,\n \"source_id\": \"7353070\",\n \"type\": \"VL\",\n \"type_description\": \"Visa Load\",\n \"trans_code\": \"PEVL\",\n \"arn\": \"\",\n \"merchant_id\": null,\n \"external_trans_id\": \"\",\n \"calculated_balance\": 30.11,\n \"ach_trans_id\": null,\n \"auth_ts\": null,\n \"prior_id\": \"0\",\n \"card_id\": \"N/A\",\n \"formatted_merchant_desc\": null,\n \"network_code\": null,\n \"auth_id\": null,\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": null,\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\",\n \"rolling_balance\": 30.11\n },\n {\n \"is_savings\": true,\n \"deny_code\": null,\n \"disputable\": false,\n \"details\": \"visa test0\",\n \"act_type\": \"FE\",\n \"act_type_description\": \"Fee\",\n \"post_ts\": \"2025-07-15 14:13:25\",\n \"amt\": -1.57,\n \"source_id\": \"47033109\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"FE000A\",\n \"arn\": \"\",\n \"merchant_id\": null,\n \"external_trans_id\": \"X02U4F1IR42UCE8LDSLE4SRD03MGYOK34SLOJPK92WEJCIHDM9OMGUDEC8O8\",\n \"calculated_balance\": 30.11,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-15 14:13:25\",\n \"prior_id\": \"0\",\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": null,\n \"network_code\": \"V\",\n \"auth_id\": \"47033109\",\n \"local_amt\": 1.44,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 1.29,\n \"settle_curr_code\": \"840\",\n \"billing_amt\": 1.29,\n \"billing_curr_code\": \"840\",\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"5733\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\",\n \"rolling_balance\": 30.11\n },\n {\n \"is_savings\": true,\n \"deny_code\": null,\n \"disputable\": false,\n \"details\": \"discover auth test0\",\n \"act_type\": \"DC\",\n \"act_type_description\": \"DC\",\n \"post_ts\": \"2025-07-15 14:13:25\",\n \"amt\": 1.61,\n \"source_id\": \"1\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"DCA\",\n \"arn\": \"\",\n \"merchant_id\": null,\n \"external_trans_id\": \"FRL96KQMED6PMC5X7IXYHXAF3EYKQII90B79JL78VWAPVDOEDX5MMOW8L63X\",\n \"calculated_balance\": 31.68,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-15 14:13:25\",\n \"prior_id\": \"0\",\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": null,\n \"network_code\": \"D\",\n \"auth_id\": \"1\",\n \"local_amt\": 1.44,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 1.29,\n \"settle_curr_code\": \"840\",\n \"billing_amt\": 1.29,\n \"billing_curr_code\": \"840\",\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"6993\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\",\n \"rolling_balance\": 31.68\n },\n {\n \"is_savings\": true,\n \"deny_code\": \"57\",\n \"disputable\": false,\n \"details\": \"AIN\\\\BANK\\\\LOB SIOUX CITY IAUS
Deny Code: 57\",\n \"act_type\": \"DA\",\n \"act_type_description\": \"Denied Auth\",\n \"post_ts\": \"2025-07-15 14:13:25\",\n \"amt\": -1.57,\n \"source_id\": \"47033108\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"DAA\",\n \"arn\": \"\",\n \"merchant_id\": \"324234 \",\n \"external_trans_id\": \"\",\n \"calculated_balance\": 30.07,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-15 14:13:25\",\n \"prior_id\": \"1234567890\",\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": null,\n \"network_code\": \"I\",\n \"auth_id\": \"47033108\",\n \"local_amt\": 1.57,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 32423.42,\n \"settle_curr_code\": \"841\",\n \"billing_amt\": 243423.42,\n \"billing_curr_code\": \"840\",\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"5733\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\",\n \"rolling_balance\": 30.07\n },\n {\n \"is_savings\": true,\n \"deny_code\": \"57\",\n \"disputable\": false,\n \"details\": \"12star - AIN\\\\BANK\\\\LOB SIOUX CITY IAUS\\\\Q
Deny Code: 57\",\n \"act_type\": \"DA\",\n \"act_type_description\": \"Denied Auth\",\n \"post_ts\": \"2025-07-15 14:12:25\",\n \"amt\": -3.18,\n \"source_id\": \"1\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"DAA\",\n \"arn\": \"\",\n \"merchant_id\": \"12star \",\n \"external_trans_id\": \"\",\n \"calculated_balance\": 30.07,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-15 14:12:25\",\n \"prior_id\": null,\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": null,\n \"network_code\": \"S\",\n \"auth_id\": \"1\",\n \"local_amt\": 3.18,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 3434534.53,\n \"settle_curr_code\": null,\n \"billing_amt\": 3434534.53,\n \"billing_curr_code\": null,\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"7273\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"4567\",\n \"rolling_balance\": 30.07\n },\n {\n \"is_savings\": true,\n \"deny_code\": \"57\",\n \"disputable\": false,\n \"details\": \"12db - AIN\\\\BANK\\\\LOB SIOUX CITY IAUS
Deny Code: 57\",\n \"act_type\": \"DA\",\n \"act_type_description\": \"Denied Auth\",\n \"post_ts\": \"2025-07-15 14:09:25\",\n \"amt\": -8,\n \"source_id\": \"8565124\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"DAA\",\n \"arn\": \"\",\n \"merchant_id\": \"12db\",\n \"external_trans_id\": \"\",\n \"calculated_balance\": 30.07,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-15 14:09:25\",\n \"prior_id\": null,\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": null,\n \"network_code\": \"P\",\n \"auth_id\": \"8565124\",\n \"local_amt\": 8,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 3434534.53,\n \"settle_curr_code\": null,\n \"billing_amt\": 3434534.53,\n \"billing_curr_code\": null,\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"7393\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"4567.9876\",\n \"rolling_balance\": 30.07\n },\n {\n \"is_savings\": true,\n \"deny_code\": null,\n \"disputable\": true,\n \"details\": \"visa test0\",\n \"act_type\": \"VS\",\n \"act_type_description\": \"Visa Settlement\",\n \"post_ts\": \"2025-07-14 14:13:26\",\n \"amt\": 1.57,\n \"source_id\": \"47033103\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"VSA\",\n \"arn\": \"\",\n \"merchant_id\": null,\n \"external_trans_id\": \"P1FRACAE8RIS9F2S4459HHF49WB8XH441TMDLBQ8I13HS2YDYWCBZ057BX73\",\n \"calculated_balance\": 30.07,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-14 14:13:26\",\n \"prior_id\": \"0\",\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": \"VISA TEST0\",\n \"network_code\": \"V\",\n \"auth_id\": \"47033103\",\n \"local_amt\": 1.44,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 1.29,\n \"settle_curr_code\": \"840\",\n \"billing_amt\": 1.29,\n \"billing_curr_code\": \"840\",\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"5733\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\",\n \"rolling_balance\": 31.68\n },\n {\n \"is_savings\": true,\n \"deny_code\": null,\n \"disputable\": false,\n \"details\": \"Pending Payment\",\n \"act_type\": \"PE\",\n \"act_type_description\": \"Pending Payment\",\n \"post_ts\": \"2025-07-14 13:12:26\",\n \"amt\": 2.17,\n \"source_id\": \"7353071\",\n \"type\": \"VL\",\n \"type_description\": \"Visa Load\",\n \"trans_code\": \"PEVL\",\n \"arn\": \"\",\n \"merchant_id\": null,\n \"external_trans_id\": \"\",\n \"calculated_balance\": 28.5,\n \"ach_trans_id\": null,\n \"auth_ts\": null,\n \"prior_id\": \"0\",\n \"card_id\": \"N/A\",\n \"formatted_merchant_desc\": null,\n \"network_code\": null,\n \"auth_id\": null,\n \"local_amt\": null,\n \"local_curr_code\": null,\n \"settle_amt\": null,\n \"settle_curr_code\": null,\n \"billing_amt\": null,\n \"billing_curr_code\": null,\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": null,\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\",\n \"rolling_balance\": 28.5\n },\n {\n \"is_savings\": true,\n \"deny_code\": null,\n \"disputable\": true,\n \"details\": \"visa test1\",\n \"act_type\": \"VS\",\n \"act_type_description\": \"Visa Settlement\",\n \"post_ts\": \"2025-07-13 13:12:26\",\n \"amt\": 3.14,\n \"source_id\": \"47033104\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"VSA\",\n \"arn\": \"\",\n \"merchant_id\": null,\n \"external_trans_id\": \"I9M3ZIJVEY70QHOWHF3RGYPG0GPV6BA1R0LTT4DMNQ4389U1EKT32BEZ0Z4K\",\n \"calculated_balance\": 28.5,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-13 13:12:26\",\n \"prior_id\": \"0\",\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": \"VISA TEST1\",\n \"network_code\": \"V\",\n \"auth_id\": \"47033104\",\n \"local_amt\": 1.44,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 1.29,\n \"settle_curr_code\": \"840\",\n \"billing_amt\": 1.29,\n \"billing_curr_code\": \"840\",\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"5733\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\",\n \"rolling_balance\": 28.5\n },\n {\n \"is_savings\": true,\n \"deny_code\": \"57 \",\n \"disputable\": false,\n \"details\": \"FIBERSTORE HONG KONG HK\",\n \"act_type\": \"DA\",\n \"act_type_description\": \"Denied Auth\",\n \"post_ts\": \"2025-07-13 10:13:25\",\n \"amt\": -4.86,\n \"source_id\": \"1\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"DAA\",\n \"arn\": \"\",\n \"merchant_id\": \"12all \",\n \"external_trans_id\": \"\",\n \"calculated_balance\": 25.36,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-13 10:13:25\",\n \"prior_id\": null,\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": null,\n \"network_code\": \"A\",\n \"auth_id\": \"1\",\n \"local_amt\": 4.86,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 3434534.53,\n \"settle_curr_code\": null,\n \"billing_amt\": 3434534.53,\n \"billing_curr_code\": null,\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"3135\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\",\n \"rolling_balance\": 25.36\n },\n {\n \"is_savings\": true,\n \"deny_code\": null,\n \"disputable\": true,\n \"details\": \"visa test2\",\n \"act_type\": \"VS\",\n \"act_type_description\": \"Visa Settlement\",\n \"post_ts\": \"2025-07-12 12:11:26\",\n \"amt\": 4.71,\n \"source_id\": \"47033105\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"VSA\",\n \"arn\": \"\",\n \"merchant_id\": null,\n \"external_trans_id\": \"5N4THXRGHZ290LOPKBH1GPZ1ALWPJOM6NCWXZK6YK9DY3XT32M2Q1MTLE5X5\",\n \"calculated_balance\": 25.36,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-12 12:11:26\",\n \"prior_id\": \"0\",\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": \"VISA TEST2\",\n \"network_code\": \"V\",\n \"auth_id\": \"47033105\",\n \"local_amt\": 1.44,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 1.29,\n \"settle_curr_code\": \"840\",\n \"billing_amt\": 1.29,\n \"billing_curr_code\": \"840\",\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"5733\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\",\n \"rolling_balance\": 25.36\n },\n {\n \"is_savings\": true,\n \"deny_code\": null,\n \"disputable\": false,\n \"details\": \"pulse auth test3\",\n \"act_type\": \"PU\",\n \"act_type_description\": \"Pulse Auth\",\n \"post_ts\": \"2025-07-12 08:13:25\",\n \"amt\": 6.52,\n \"source_id\": \"1\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"PUA\",\n \"arn\": \"\",\n \"merchant_id\": null,\n \"external_trans_id\": \"PJC2DDD1AHKKNR0S3ZGT68BFYJ2BQJJSODWYZ0EFU6N8I2YKO95ZHWACGXS2\",\n \"calculated_balance\": 20.65,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-12 08:13:25\",\n \"prior_id\": \"0\",\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": \"PULSE AUTH TEST3\",\n \"network_code\": \"B\",\n \"auth_id\": \"1\",\n \"local_amt\": 1.44,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 1.29,\n \"settle_curr_code\": \"840\",\n \"billing_amt\": 1.29,\n \"billing_curr_code\": \"840\",\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"3662\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\",\n \"rolling_balance\": 20.65\n },\n {\n \"is_savings\": true,\n \"deny_code\": \"57\",\n \"disputable\": false,\n \"details\": \"FIBERSTORE HONG KONG HK\",\n \"act_type\": \"DA\",\n \"act_type_description\": \"Denied Auth\",\n \"post_ts\": \"2025-07-12 08:13:25\",\n \"amt\": -6.52,\n \"source_id\": \"1\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"DAA\",\n \"arn\": \"\",\n \"merchant_id\": \"12pulse \",\n \"external_trans_id\": \"\",\n \"calculated_balance\": 14.13,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-12 08:13:25\",\n \"prior_id\": null,\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": null,\n \"network_code\": \"B\",\n \"auth_id\": \"1\",\n \"local_amt\": 6.52,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 3434534.53,\n \"settle_curr_code\": null,\n \"billing_amt\": 3434534.53,\n \"billing_curr_code\": null,\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"3662\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\",\n \"rolling_balance\": 14.13\n },\n {\n \"is_savings\": true,\n \"deny_code\": null,\n \"disputable\": true,\n \"details\": \"visa test3\",\n \"act_type\": \"VS\",\n \"act_type_description\": \"Visa Settlement\",\n \"post_ts\": \"2025-07-11 11:10:26\",\n \"amt\": 6.28,\n \"source_id\": \"47033106\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"VSA\",\n \"arn\": \"\",\n \"merchant_id\": null,\n \"external_trans_id\": \"KNXXAPBYN77WA3GDEHJDE633875ZM0A50D5YWCZ967QJFUI9X1AGDR6MA4J9\",\n \"calculated_balance\": 14.13,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-11 11:10:26\",\n \"prior_id\": \"0\",\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": \"VISA TEST3\",\n \"network_code\": \"V\",\n \"auth_id\": \"47033106\",\n \"local_amt\": 1.44,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 1.29,\n \"settle_curr_code\": \"840\",\n \"billing_amt\": 1.29,\n \"billing_curr_code\": \"840\",\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"5733\",\n \"iac_tax\": \"0\",\n \"iva_tax\": \"0\",\n \"rolling_balance\": 14.13\n },\n {\n \"is_savings\": true,\n \"deny_code\": null,\n \"disputable\": true,\n \"details\": \"visa test4\",\n \"act_type\": \"VS\",\n \"act_type_description\": \"Visa Settlement\",\n \"post_ts\": \"2025-07-10 10:09:26\",\n \"amt\": 7.85,\n \"source_id\": \"47033107\",\n \"type\": \"A\",\n \"type_description\": \"\",\n \"trans_code\": \"VSA\",\n \"arn\": \"\",\n \"merchant_id\": null,\n \"external_trans_id\": \"RFH4NC2KLJKXKQXREEHYGU58TPRKZZ0PP2KLQGKA0PL9ZYNLL3ABYUGQAM7Q\",\n \"calculated_balance\": 7.85,\n \"ach_trans_id\": null,\n \"auth_ts\": \"2025-07-10 10:09:26\",\n \"prior_id\": \"0\",\n \"card_id\": \"14861193\",\n \"formatted_merchant_desc\": \"VISA TEST4\",\n \"network_code\": \"V\",\n \"auth_id\": \"47033107\",\n \"local_amt\": 1.44,\n \"local_curr_code\": \"840\",\n \"settle_amt\": 1.29,\n \"settle_curr_code\": \"840\",\n \"billing_amt\": 1.29,\n \"billing_curr_code\": \"840\",\n \"pmt_ref_no\": \"005461522202\",\n \"mcc_code\": \"5733\",\n \"iac_tax\": \"3456217890.7654\",\n \"iva_tax\": \"45.67\",\n \"rolling_balance\": 7.85\n }\n ],\n \"beginning_balance\": 0\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"681a5fab-9570-4b40-a531-69ae657d3264\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 14:13:28\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.577\n \n 15\n 1\n 15\n 1\n 2025-06-15 00:00:00\n 2025-07-16 23:59:59\n \n 6.52\n 23.55\n 0\n -1.57\n 0\n \n \n \n true\n \n false\n Pending Payment \n PE\n Pending Payment\n 2025-07-15 14:13:26\n 1\n 7353070\n VL\n Visa Load\n PEVL\n \n \n \n 30.11\n \n \n 0\n N/A\n \n \n \n \n \n \n \n \n \n 005461522202\n \n 0\n 0\n 30.11\n \n \n true\n \n false\n visa test0 \n FE\n Fee\n 2025-07-15 14:13:25\n -1.57\n 47033109\n A\n \n FE000A\n \n \n X02U4F1IR42UCE8LDSLE4SRD03MGYOK34SLOJPK92WEJCIHDM9OMGUDEC8O8\n 30.11\n \n 2025-07-15 14:13:25\n 0\n 14861193\n \n V\n 47033109\n 1.44\n 840\n 1.29\n 840\n 1.29\n 840\n 005461522202\n 5733\n 0\n 0\n 30.11\n \n \n true\n \n false\n discover auth test0 \n DC\n DC\n 2025-07-15 14:13:25\n 1.61\n 1\n A\n \n DCA\n \n \n FRL96KQMED6PMC5X7IXYHXAF3EYKQII90B79JL78VWAPVDOEDX5MMOW8L63X\n 31.68\n \n 2025-07-15 14:13:25\n 0\n 14861193\n \n D\n 1\n 1.44\n 840\n 1.29\n 840\n 1.29\n 840\n 005461522202\n 6993\n 0\n 0\n 31.68\n \n \n true\n 57\n false\n AIN\\BANK\\LOB SIOUX CITY IAUS<br><b>Deny Code: </b>57 \n DA\n Denied Auth\n 2025-07-15 14:13:25\n -1.57\n 47033108\n A\n \n DAA\n \n 324234\n \n 30.07\n \n 2025-07-15 14:13:25\n 1234567890\n 14861193\n \n I\n 47033108\n 1.57\n 840\n 32423.42\n 841\n 243423.42\n 840\n 005461522202\n 5733\n 0\n 0\n 30.07\n \n \n true\n 57\n false\n 12star - AIN\\BANK\\LOB SIOUX CITY IAUS\\Q<br><b>Deny Code: </b>57 \n DA\n Denied Auth\n 2025-07-15 14:12:25\n -3.18\n 1\n A\n \n DAA\n \n 12star\n \n 30.07\n \n 2025-07-15 14:12:25\n \n 14861193\n \n S\n 1\n 3.18\n 840\n 3434534.53\n \n 3434534.53\n \n 005461522202\n 7273\n 0\n 4567\n 30.07\n \n \n true\n 57\n false\n 12db - AIN\\BANK\\LOB SIOUX CITY IAUS<br><b>Deny Code: </b>57 \n DA\n Denied Auth\n 2025-07-15 14:09:25\n -8\n 8565124\n A\n \n DAA\n \n 12db\n \n 30.07\n \n 2025-07-15 14:09:25\n \n 14861193\n \n P\n 8565124\n 8\n 840\n 3434534.53\n \n 3434534.53\n \n 005461522202\n 7393\n 0\n 4567.9876\n 30.07\n \n \n true\n \n true\n visa test0 \n VS\n Visa Settlement\n 2025-07-14 14:13:26\n 1.57\n 47033103\n A\n \n VSA\n \n \n P1FRACAE8RIS9F2S4459HHF49WB8XH441TMDLBQ8I13HS2YDYWCBZ057BX73\n 30.07\n \n 2025-07-14 14:13:26\n 0\n 14861193\n VISA TEST0\n V\n 47033103\n 1.44\n 840\n 1.29\n 840\n 1.29\n 840\n 005461522202\n 5733\n 0\n 0\n 31.68\n \n \n true\n \n false\n Pending Payment \n PE\n Pending Payment\n 2025-07-14 13:12:26\n 2.17\n 7353071\n VL\n Visa Load\n PEVL\n \n \n \n 28.5\n \n \n 0\n N/A\n \n \n \n \n \n \n \n \n \n 005461522202\n \n 0\n 0\n 28.5\n \n \n true\n \n true\n visa test1 \n VS\n Visa Settlement\n 2025-07-13 13:12:26\n 3.14\n 47033104\n A\n \n VSA\n \n \n I9M3ZIJVEY70QHOWHF3RGYPG0GPV6BA1R0LTT4DMNQ4389U1EKT32BEZ0Z4K\n 28.5\n \n 2025-07-13 13:12:26\n 0\n 14861193\n VISA TEST1\n V\n 47033104\n 1.44\n 840\n 1.29\n 840\n 1.29\n 840\n 005461522202\n 5733\n 0\n 0\n 28.5\n \n \n true\n 57 \n false\n FIBERSTORE HONG KONG HK \n DA\n Denied Auth\n 2025-07-13 10:13:25\n -4.86\n 1\n A\n \n DAA\n \n 12all\n \n 25.36\n \n 2025-07-13 10:13:25\n \n 14861193\n \n A\n 1\n 4.86\n 840\n 3434534.53\n \n 3434534.53\n \n 005461522202\n 3135\n 0\n 0\n 25.36\n \n \n true\n \n true\n visa test2 \n VS\n Visa Settlement\n 2025-07-12 12:11:26\n 4.71\n 47033105\n A\n \n VSA\n \n \n 5N4THXRGHZ290LOPKBH1GPZ1ALWPJOM6NCWXZK6YK9DY3XT32M2Q1MTLE5X5\n 25.36\n \n 2025-07-12 12:11:26\n 0\n 14861193\n VISA TEST2\n V\n 47033105\n 1.44\n 840\n 1.29\n 840\n 1.29\n 840\n 005461522202\n 5733\n 0\n 0\n 25.36\n \n \n true\n \n false\n pulse auth test3 \n PU\n Pulse Auth\n 2025-07-12 08:13:25\n 6.52\n 1\n A\n \n PUA\n \n \n PJC2DDD1AHKKNR0S3ZGT68BFYJ2BQJJSODWYZ0EFU6N8I2YKO95ZHWACGXS2\n 20.65\n \n 2025-07-12 08:13:25\n 0\n 14861193\n PULSE AUTH TEST3\n B\n 1\n 1.44\n 840\n 1.29\n 840\n 1.29\n 840\n 005461522202\n 3662\n 0\n 0\n 20.65\n \n \n true\n 57\n false\n FIBERSTORE HONG KONG HK \n DA\n Denied Auth\n 2025-07-12 08:13:25\n -6.52\n 1\n A\n \n DAA\n \n 12pulse\n \n 14.13\n \n 2025-07-12 08:13:25\n \n 14861193\n \n B\n 1\n 6.52\n 840\n 3434534.53\n \n 3434534.53\n \n 005461522202\n 3662\n 0\n 0\n 14.13\n \n \n true\n \n true\n visa test3 \n VS\n Visa Settlement\n 2025-07-11 11:10:26\n 6.28\n 47033106\n A\n \n VSA\n \n \n KNXXAPBYN77WA3GDEHJDE633875ZM0A50D5YWCZ967QJFUI9X1AGDR6MA4J9\n 14.13\n \n 2025-07-11 11:10:26\n 0\n 14861193\n VISA TEST3\n V\n 47033106\n 1.44\n 840\n 1.29\n 840\n 1.29\n 840\n 005461522202\n 5733\n 0\n 0\n 14.13\n \n \n true\n \n true\n visa test4 \n VS\n Visa Settlement\n 2025-07-10 10:09:26\n 7.85\n 47033107\n A\n \n VSA\n \n \n RFH4NC2KLJKXKQXREEHYGU58TPRKZZ0PP2KLQGKA0PL9ZYNLL3ABYUGQAM7Q\n 7.85\n \n 2025-07-10 10:09:26\n 0\n 14861193\n VISA TEST4\n V\n 47033107\n 1.44\n 840\n 1.29\n 840\n 1.29\n 840\n 005461522202\n 5733\n 3456217890.7654\n 45.67\n 7.85\n \n \n 0\n \n \n \n \n 681a5fab-9570-4b40-a531-69ae657d3264\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 14:13:28\n"}}}},"description":""}},"parameters":[],"summary":"Get All Transaction History","description":"Use the Get All Transaction History endpoint to retrieve all of the transactions on the SoFi Tech Solutions ledger, including backouts, denied transactions, <>-only requests, and tokenization requests.\n- This endpoint returns the same transactions as the *All Transactions* page in the <>.\n- Transactions are returned newest first, ordered by `post_ts` descending. Because `post_ts` has one-second precision, transactions sharing the same second are then ordered by `act_id` descending. Pending payments and denied authorizations have no `act_id` and are returned after the posted transactions they share a `post_ts` with.\n- See Record-Set Pagination for instructions on using the paging parameters.\n- Open the Recipes below to see response examples.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"startDate":{"type":"string","format":"date","description":"The beginning date for the date range, either a date or a date-time.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`"},"endDate":{"type":"string","format":"date","description":"The end date for the date range, either a date or a date-time. Must be equal to or later than `startDate`. Max 1098 days (~3 years) after `startDate`. \nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"page":{"type":"integer","format":"int32","default":1,"nullable":true,"minimum":1,"maximum":999999,"description":"The number of the page to retrieve.\nPattern: Integer value of `1` or greater\nExample: `3`","example":3},"recordCnt":{"type":"integer","format":"int32","nullable":true,"minimum":1,"maximum":99999,"description":"The maximum number of records per page to be returned.\nPattern: Positive integer `1-99999`\nExample: `100`","example":100}},"required":["accountNo","endDate","startDate","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Transactions"],"operationId":"post_getalltranshistory"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getPendingFees":{"post":{"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"fees":{"type":"array","description":"List of fees","items":{"type":"object","properties":{"fee_event_id":{"type":"string","description":"System-generated fee transaction integer ID"},"type":{"type":"string","description":"Three-letter fee code. This is not the transaction type (otype)."},"type_description":{"type":"string","description":"A description of the type code"},"amt":{"type":"string","description":"Amount of the fee charge"},"fee_date":{"type":"string","format":"date-time","description":"A timestamp for the time the fee was charged"},"card_id":{"type":"integer","format":"int32","nullable":true,"description":"Integer identifier of the card as found in the raw data file (RDF). Unique identifier for a PAN."},"fee_description":{"type":"string","description":"The description on a fee"},"related_transaction":{"nullable":true,"description":"A data structure that contains information on transactions related to a fee","type":"object","properties":{"details":{"type":"string","nullable":true,"description":"Information on a transaction or authorization"},"amt":{"type":"number","format":"float","description":"Amount of a fee or transaction charge"},"post_ts":{"type":"string","format":"date-time","description":"The time stamp of a posted transaction"}},"required":["amt","details","post_ts"]}},"required":["amt","card_id","fee_date","fee_description","fee_event_id","related_transaction","type","type_description"]}}},"required":["fees"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.464,\n \"response_data\": {\n \"fees\": [\n {\n \"fee_event_id\": \"65755855\",\n \"type\": \"ITC\",\n \"type_description\": \"0220\",\n \"amt\": \"-13.35\",\n \"fee_date\": \"2025-07-15 06:24:36\",\n \"card_id\": \"14861213\",\n \"fee_description\": \"Foreign Transaction Credit\",\n \"related_transaction\": null\n },\n {\n \"fee_event_id\": \"65755854\",\n \"type\": \"TRC\",\n \"type_description\": \"0029\",\n \"amt\": \"-12.18\",\n \"fee_date\": \"2025-07-15 07:26:36\",\n \"card_id\": \"14861213\",\n \"fee_description\": \"Credit Transaction\",\n \"related_transaction\": null\n },\n {\n \"fee_event_id\": \"65755853\",\n \"type\": \"DED\",\n \"type_description\": \"0025\",\n \"amt\": \"-11.01\",\n \"fee_date\": \"2025-07-15 08:28:36\",\n \"card_id\": \"14861213\",\n \"fee_description\": \"Denied Credit Domestic Transaction\",\n \"related_transaction\": null\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"2eec1721-cfaf-4247-95f8-46aa4a5cccb7\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 14:41:38\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.046\n \n \n \n 65755855\n ITC\n 0220\n -13.35\n 2025-07-15 06:24:36\n 14861213\n Foreign Transaction Credit\n \n \n \n 65755854\n TRC\n 0029\n -12.18\n 2025-07-15 07:26:36\n 14861213\n Credit Transaction\n \n \n \n 65755853\n DED\n 0025\n -11.01\n 2025-07-15 08:28:36\n 14861213\n Denied Credit Domestic Transaction\n \n \n \n \n \n \n \n 0cd102c3-a6df-47a4-9835-0c4a1bf6304a\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 14:41:39\n"}}}},"description":""}},"parameters":[],"summary":"Get Pending Fees","description":"Use the Get Pending Fees endpoint to retrieve the fees that have not yet been processed against the specified customer account. Most fees are processed as soon as they are created, but if the account has insufficient funds to pay the fee, the fee will be pending until there are sufficient funds.\n- The response data for this endpoint is also available in the Get Account Overview response.\n- The response for each individual pending fee will include authorization-related transaction information, if applicable, which is in the `related_transaction` data element.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Transactions"],"operationId":"post_getpendingfees"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getSavingsInterest":{"post":{"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"apy":{"type":"string","description":"The actual interest rate used to calculate compound interest over the course of one year"},"interest_ytd":{"type":"string","description":"The interest paid on a savings account from the start date to the end date"},"accrual_interest":{"type":"number","format":"float","description":"Interest accrued on account"},"start_date":{"type":"string","format":"date-time","description":"The start date of a response"},"carry_over":{"type":"number","format":"float","description":"The carry over interest pending on a savings account on the end date"},"end_date":{"type":"string","format":"date-time","description":"The end date of a response"}},"required":["accrual_interest","apy","carry_over","end_date","interest_ytd","start_date"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.413,\n \"response_data\": {\n \"interest_ytd\": \"331.53\",\n \"end_date\": \"2025-07-16 23:59:59\",\n \"start_date\": \"2025-06-14 00:00:00\",\n \"carry_over\": \"0.43\",\n \"apy\": \"2.02\",\n \"accrual_interest\": \".018166598\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"42112d54-c156-492f-987f-2c72c4b9620f\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 14:49:05\"\n}\n"}}},"application/xml":{"examples":{"response":{"value":"\n0\nSuccess\n0.413\n\n 331.53\n 2025-07-16 23:59:59\n 2025-06-14 00:00:00\n 0.43\n 2.02\n .018166598\n\n\n \n \n 42112d54-c156-492f-987f-2c72c4b9620f\n\n8cc16de0-5eda-4e2a-968e-3b08fce6f778\n2025-07-15 14:49:05\n"}}}},"description":""}},"parameters":[],"summary":"Get Savings Interest","description":"Use the Get Savings Interest endpoint to retrieve accrual interest, interest year-to-date, and annual percentage yield earned for a savings account that is a secondary account. If you are already using Get Savings Interest, SoFi Tech Solutions recommends that you migrate to Get Interest.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <> or <> of the account.\nPattern: PAN or PRN.\nExample: 074103447228.","example":"074103447228"},"startDate":{"type":"string","format":"date","description":"The beginning date for the date range, either a date or a date-time.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss.\nExample: 2016-01-01.","example":"2016-01-01"},"endDate":{"type":"string","format":"date","description":"The end date for the date range, either a date or a date-time. Must be equal to or later than startDate.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss.\nExample: 2016-01-01.","example":"2016-01-01"}},"required":["accountNo","endDate","startDate","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Accounts and Cards"],"operationId":"post_getsavingsinterest"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getInterest":{"post":{"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"type":"array","nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","items":{"type":"object","properties":{"apye":{"type":"number","format":"float","description":"The Annual Percentage Yield Earned (APYE) for the requested month"},"adb":{"type":"number","format":"float","nullable":true,"description":"The <> for the requested month. Populated only when an internal feature flag is set and a monthly interest record exists. Returns 0 for non-ADB products when a monthly interest record exists but the ADB value is not set. Null only when the legacy read path is active (flag off or monthly interest record missing)."},"start_date":{"type":"string","format":"date","description":"The start date of the requested month"},"interest_payout":{"type":"number","format":"float","description":"Interest accrued on account to two decimal places. This includes carryover from the previous month and is what the account has been paid or will be paid."},"carryover_previous_month":{"type":"number","format":"float","description":"The remainder interest from the previous month that is carried over to the requested month"},"interest_paid_ytd":{"type":"number","format":"float","description":"The interest paid on the account for today's year to date. The `interestMonth` argument does not affect this value."},"accrual_interest_without_carryover":{"type":"number","format":"float","description":"Interest accrued on the account without carryover from the previous month"},"product_description":{"type":"string","nullable":true,"description":"Product Description"},"account_no":{"type":"integer","format":"int32","description":"Account No"},"product_id":{"type":"integer","format":"int32","description":"Product Id"},"end_date":{"type":"string","format":"date","description":"The end date of the requested month"}},"required":["account_no","accrual_interest_without_carryover","apye","carryover_previous_month","end_date","interest_paid_ytd","interest_payout","product_description","product_id","start_date"]}}},"required":["echo","processing_time","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.413,\n \"response_data\": {\n \"interest\": {\n \"product_id\": 88,\n \"product_description\": \"Blue Kingfisher VISA\",\n \"account_no\": \"999101789000\",\n \"interest_payout\": 0.02,\n \"accrual_interest_without_carryover\": 0.018166598,\n \"carryover_previous_month\": 0.0024343343,\n \"interest_paid_ytd\": 331.53,\n \"apye\": 2.02,\n \"start_date\": \"2025-05-01\",\n \"end_date\": \"2025-05-31\"\n }\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"42112d54-c156-492f-987f-2c72c4b9620f\"\n },\n \"system_timestamp\": \"2026-01-13 15:30:24\",\n \"rtoken\": \"8e264f42-86fc-413c-ae71-64aa6acf5009\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.413\n \n \n 88\n Blue Kingfisher VISA\n 999101789000\n 0.02\n 0.018166598\n 0.0024343343\n 331.53\n 2.02\n 2025-05-01\n 2025-05-31\n \n \n \n \n \n 42112d54-c156-492f-987f-2c72c4b9620f\n \n\n\n"}}}},"description":""}},"parameters":[],"summary":"Get Interest","description":"Use the Get Interest endpoint to retrieve accrual interest, interest year-to-date, and annual percentage yield for any type of interest bearing account (savings or non-savings).\n\nThe Get Interest endpoint is the preferred method for retrieving data on interest-bearing accounts.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"interestMonth":{"type":"string","format":"date","description":"The month to retrieve interest data for.\nPattern: YYYY-MM\nExample: `2020-01`.","example":"2020-01"},"includeRelated":{"type":"integer","format":"int32","default":0,"enum":[0,1],"description":"Whether to return data for related accounts. \n\nWhen `accountNo` contains a primary account:\n- `0` — **Default**. Retrieve data only for the specified account.\n- `1` — Also retrieve data for accounts that share the same balance or account owner.\n\nWhen `accountNo` contains a secondary account:\n- `0` — **Default**. Retrieve data only for the specified account.\n- `1` — Also retrieve data for other secondary accounts of the primary (but not primary-account data).\n\nPattern: Integer\nExample: `1`","example":1}},"required":["interestMonth","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Accounts and Cards"],"operationId":"post_getinterest"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getPaymentHistory":{"post":{"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"transaction_count":{"type":"integer","format":"int32","description":"The number of transactions listed in the response"},"page":{"type":"integer","format":"int32","description":"The page number to be retrieved in the context of recordset paging"},"total_record_count":{"type":"integer","format":"int32","description":"Number of records in the accounts list display"},"number_of_pages":{"type":"integer","format":"int32","description":"Total number of pages in the accounts list display"},"start_date":{"type":"string","format":"date-time","description":"The start date for the response"},"end_date":{"type":"string","format":"date-time","description":"The end date for the response"},"payments":{"type":"array","description":"List of Payments","items":{"type":"object","properties":{"pmt_id":{"type":"string","description":"ID assigned to the specific payment"},"details":{"type":"string","description":"Description of the payment"},"amount":{"type":"string","description":"An amount of a payment"},"timestamp":{"type":"string","format":"date-time","description":"The date and time of the payment"},"source_id":{"type":"string","nullable":true,"description":"A code unique to the source of the payment"},"ach_transaction_id":{"type":"string","nullable":true,"description":"A unique ID for an ACH transaction"},"external_trans_id":{"type":"string","nullable":true,"description":"User-supplied identifier that is related to an external system"},"hold_days":{"type":"string","nullable":true,"description":"The number of days on a hold. Specific to a pending payment, usually due to load-limt violations or from a hold placed by Create Payment"},"status":{"type":"string","nullable":true,"description":"Status designator of the payment; see [Payment `status` codes](#payment-status-codes) for valid values"},"status_description":{"type":"string","nullable":true,"description":"Descriptor for `status`"}},"required":["ach_transaction_id","amount","details","external_trans_id","hold_days","pmt_id","source_id","status","status_description","timestamp"]}}},"required":["end_date","number_of_pages","page","payments","start_date","total_record_count","transaction_count"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.058,\n \"response_data\": {\n \"transaction_count\": 3,\n \"page\": 1,\n \"total_record_count\": 3,\n \"number_of_pages\": 1,\n \"start_date\": \"2025-08-30 00:00:00\",\n \"end_date\": \"2025-09-20 23:59:59\",\n \"payments\": [\n {\n \"pmt_id\": \"40346\",\n \"details\": \"Retail Load\",\n \"amount\": \"10\",\n \"timestamp\": \"2025-09-20 13:44:11\",\n \"source_id\": \"0\",\n \"ach_transaction_id\": null,\n \"external_trans_id\": \"34VJ0VLSP79B5Y346TYJ\",\n \"hold_days\": \"0\",\n \"status\": \"P\",\n \"status_description\": \"Processed\"\n },\n {\n \"pmt_id\": \"40345\",\n \"details\": \"Card to Card\",\n \"amount\": \"1.25\",\n \"timestamp\": \"2025-09-20 13:44:10\",\n \"source_id\": null,\n \"ach_transaction_id\": null,\n \"external_trans_id\": \"QO74VUSYICQ1E7MIBP7O\",\n \"hold_days\": \"0\",\n \"status\": \"P\",\n \"status_description\": \"Processed\"\n },\n {\n \"pmt_id\": \"40341\",\n \"details\": \"Card to Card\",\n \"amount\": \"1.25\",\n \"timestamp\": \"2025-09-20 13:43:59\",\n \"source_id\": null,\n \"ach_transaction_id\": null,\n \"external_trans_id\": \"DRKFROGTALB50FYUR3F3\",\n \"hold_days\": \"0\",\n \"status\": \"P\",\n \"status_description\": \"Processed\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"1J669F8UAM6EKPB32IS4\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:31:59\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.057\n \n 3\n 1\n 3\n 1\n 2025-08-30 00:00:00\n 2025-09-20 23:59:59\n \n \n 40346\n Retail Load \n 10\n 2025-09-20 13:44:11\n 0\n \n 34VJ0VLSP79B5Y346TYJ\n 0\n P\n Processed\n \n \n 40345\n Card to Card \n 1.25\n 2025-09-20 13:44:10\n \n \n QO74VUSYICQ1E7MIBP7O\n 0\n P\n Processed\n \n \n 40341\n Card to Card \n 1.25\n 2025-09-20 13:43:59\n \n \n DRKFROGTALB50FYUR3F3\n 0\n P\n Processed\n \n \n \n \n \n \n 0JGNO8Y3100VOPGMFD93\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 10:53:09\n"}}}},"description":""}},"parameters":[],"summary":"Get Payment History","description":"Use the Get Payment History endpoint to retrieve payments (credits) for a customer account during a specified period.\n\nSee Record-Set Pagination for instructions on using the paging parameters.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"startDate":{"type":"string","format":"date","description":"The beginning date for the date range, either a date or a date-time.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"endDate":{"type":"string","format":"date","description":"The end date for the date range, either a date or a date-time. Must be equal to or later than `startDate`. Max 1098 days (~3 years) after `startDate`. \nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"includeRelated":{"type":"integer","format":"int32","default":0,"enum":[0,1],"nullable":true,"description":"Whether to return transactions for all accounts that share the same account holder (`client_id`) or balance (`bal_id`).\n \nWhen `accountNo` contains a primary account:\n- `0` — **Default**. Retrieve all transactions that share the same balance. \n- `1` — Retrieve all transactions from the same account holder. \n\nWhen `accountNo` contains a secondary account:\n- `0` — **Default**. Retrieve all transactions from the specified account only. \n- `1` — Retrieve all transactions from the same account holder.\n \nPattern: Integer\nExample: `1`","example":1},"recordCnt":{"type":"integer","format":"int32","nullable":true,"minimum":1,"maximum":99999,"description":"The maximum number of records per page to be returned.\nPattern: Positive integer `1-99999`\nExample: `100`","example":100},"page":{"type":"integer","format":"int32","default":1,"nullable":true,"minimum":1,"maximum":999999,"description":"The number of the page to retrieve.\nPattern: Integer value of `1` or greater\nExample: `3`","example":3}},"required":["accountNo","endDate","startDate","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Transactions"],"operationId":"post_getpaymenthistory"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getFeeHistory":{"post":{"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"fee_count":{"type":"integer","format":"int32","description":"A count of fees being recorded on"},"page":{"type":"integer","format":"int32","description":"The page number to be retrieved in the context of recordset paging"},"total_record_count":{"type":"integer","format":"int32","description":"Number of records in the accounts list display"},"number_of_pages":{"type":"integer","format":"int32","description":"Total number of pages in the accounts list display"},"start_date":{"type":"string","format":"date-time","description":"The start date of the response"},"end_date":{"type":"string","format":"date-time","description":"The end date of the response"},"fees":{"type":"array","description":"List of fees","items":{"type":"object","properties":{"pmt_ref_no":{"type":"string","description":"A system-generated account number"},"fee_id":{"type":"string","description":"The ID of the fee record"},"fee_date":{"type":"string","format":"date-time","nullable":true,"description":"A timestamp for the time the fee was charged"},"amt":{"type":"string","description":"A fee or transaction amount"},"status":{"type":"string","nullable":true,"description":"The status of a fee event record return in this method"},"status_description":{"type":"string","nullable":true,"description":"A spelled-out status of the fee"},"type":{"type":"string","description":"Three-letter fee code. This is not the transaction type (otype)."},"type_description":{"type":"string","description":"A description of the type code"},"fee_event_id":{"type":"string","description":"An ID for the fee event"}},"required":["amt","fee_date","fee_event_id","fee_id","pmt_ref_no","status","status_description","type","type_description"]}}},"required":["end_date","fee_count","fees","number_of_pages","page","start_date","total_record_count"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.432,\n \"response_data\": {\n \"fee_count\": 5,\n \"start_date\": \"2025-06-15 00:00:00\",\n \"end_date\": \"2025-07-15 23:59:59\",\n \"number_of_pages\": 3,\n \"page\": 2,\n \"total_record_count\": 11,\n \"fees\": [\n {\n \"pmt_ref_no\": \"005461536202\",\n \"fee_id\": \"20982137\",\n \"fee_date\": \"2025-07-15 00:00:00\",\n \"amt\": \"-11.01\",\n \"status\": null,\n \"status_description\": null,\n \"type\": \"ATD\",\n \"type_description\": \"0013\",\n \"fee_event_id\": \"65755841\"\n },\n {\n \"pmt_ref_no\": \"005461536202\",\n \"fee_id\": \"20982136\",\n \"fee_date\": \"2025-07-15 00:00:00\",\n \"amt\": \"-9.84\",\n \"status\": null,\n \"status_description\": null,\n \"type\": \"ATD\",\n \"type_description\": \"0013\",\n \"fee_event_id\": \"65755840\"\n },\n {\n \"pmt_ref_no\": \"005461536202\",\n \"fee_id\": \"20982135\",\n \"fee_date\": \"2025-07-15 00:00:00\",\n \"amt\": \"-8.67\",\n \"status\": null,\n \"status_description\": null,\n \"type\": \"ATD\",\n \"type_description\": \"0013\",\n \"fee_event_id\": \"65755839\"\n },\n {\n \"pmt_ref_no\": \"005461536202\",\n \"fee_id\": \"20982134\",\n \"fee_date\": \"2025-07-15 00:00:00\",\n \"amt\": \"-7.5\",\n \"status\": null,\n \"status_description\": null,\n \"type\": \"ATD\",\n \"type_description\": \"0013\",\n \"fee_event_id\": \"65755838\"\n },\n {\n \"pmt_ref_no\": \"005461536202\",\n \"fee_id\": \"20982133\",\n \"fee_date\": \"2025-07-15 00:00:00\",\n \"amt\": \"-6.33\",\n \"status\": null,\n \"status_description\": null,\n \"type\": \"ATD\",\n \"type_description\": \"0013\",\n \"fee_event_id\": \"65755837\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"d1dffb5f-e3f1-442d-ba63-7c326953b8c8\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 14:31:57\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.024\n \n 5\n 2025-06-15 00:00:00\n 2025-07-15 23:59:59\n 3\n 2\n 11\n \n \n 005461536202\n 20982137\n 2025-07-15 00:00:00\n -11.01\n \n \n ATD\n 0013\n 65755841\n \n \n 005461536202\n 20982136\n 2025-07-15 00:00:00\n -9.84\n \n \n ATD\n 0013\n 65755840\n \n \n 005461536202\n 20982135\n 2025-07-15 00:00:00\n -8.67\n \n \n ATD\n 0013\n 65755839\n \n \n 005461536202\n 20982134\n 2025-07-15 00:00:00\n -7.5\n \n \n ATD\n 0013\n 65755838\n \n \n 005461536202\n 20982133\n 2025-07-15 00:00:00\n -6.33\n \n \n ATD\n 0013\n 65755837\n \n \n \n \n \n \n 05325dee-ce24-4bb0-ab55-5a5be5ed5e40\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 14:31:58\n"}}}},"description":""}},"parameters":[],"summary":"Get Fee History","description":"Use the Get Fee History endpoint to retrieve a list of fees for the specified customer account. \n\nSee Record-Set Pagination for instructions on using the paging parameters.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"startDate":{"type":"string","format":"date","description":"The beginning date for the date range, either a date or a date-time.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"endDate":{"type":"string","format":"date","description":"The end date for the date range, either a date or a date-time. Must be equal to or later than `startDate`. Max 1098 days (~3 years) after `startDate`. \nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"recordCnt":{"type":"integer","format":"int32","nullable":true,"minimum":1,"maximum":99999,"description":"The maximum number of records per page to be returned.\nPattern: Positive integer `1-99999`\nExample: `100`","example":100},"page":{"type":"integer","format":"int32","default":1,"minimum":1,"maximum":999999,"description":"The number of the page to retrieve.\nPattern: Integer value of `1` or greater\nExample: `3`","example":3}},"required":["accountNo","endDate","startDate","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Transactions"],"operationId":"post_getfeehistory"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getFeeSummary":{"post":{"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"fees_ytd":{"type":"number","format":"float","description":"Fees year-to-date"},"fees_mtd":{"type":"number","format":"float","description":"Fees month-to-date"}},"required":["fees_mtd","fees_ytd"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]}}},"description":""}},"parameters":[],"summary":"Get Fee Summary","description":"Use Get Fee Summary to retrieve the total fee amount that was posted during the specified timespan.\n\nSee Record-Set Pagination for instructions on using the paging parameters.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"ytdStart":{"type":"string","format":"date","description":"Start date for the year to date.\nPattern: YYYY-MM-DD\nExample: `\"2022-01-01\"`","example":"2022-01-01"},"ytdEnd":{"type":"string","format":"date","description":"End date of the year to date.\nPattern: YYYY-MM-DD\nExample: `\"2022-11-05\"`","example":"2022-11-05"},"mtdStart":{"type":"string","format":"date","description":"Start date of the month to date.\nPattern: YYYY-MM-DD\nExample: `\"2022-03-01\"`","example":"2022-03-01"},"mtdEnd":{"type":"string","format":"date","description":"End date of the month to date.\nPattern: YYYY-MM-DD\nExample: `\"2022-03-15\"`","example":"2022-03-15"}},"required":["accountNo","mtdEnd","mtdStart","transactionId","ytdEnd","ytdStart","apiLogin","apiTransKey","providerId"]}}}},"tags":["Transactions"],"operationId":"post_getfeesummary"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getOverdraftBalance":{"post":{"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"OverdraftAccountNo":{"type":"string","nullable":true,"description":"The <> of the overdraft account associated with the cardholder"},"Available":{"type":"number","format":"float","nullable":true,"description":"Remaining overdraft credit after the overdraft transaction fee (ODT) adjustment"},"Payback":{"type":"number","format":"float","nullable":true,"description":"The settled outstanding balance on the overdraft account, the amount currently owed excluding pending fees"},"PaybackWithPendingFees":{"type":"number","format":"float","nullable":true,"description":"The total settled outstanding overdraft balance, plus any pending fees from unsettled transactions."},"RawBalance":{"type":"number","format":"float","nullable":true,"description":"The remaining available overdraft credit on the account, calculated without any overdraft transaction fees (ODT)."},"ActualWithPrimary":{"type":"number","format":"float","nullable":true,"description":"The primary DDA available balance minus the outstanding overdraft balance. This is not the combined total of available funds across the DDA and overdraft accounts; it represents the available funds in the DDA minus the outstanding overdraft debt."},"Limit":{"type":"number","format":"float","nullable":true,"description":"The total overdraft credit limit, representing the maximum that can be borrowed if no prior balance is owed."},"RawLimit":{"type":"number","format":"float","nullable":true,"description":"The base configured overdraft credit limit. The effective limit (Limit) may be lower if the overdraft transaction fee (ODT) is enabled"},"Frozen":{"type":"string","nullable":true,"description":"Indicates whether the overdraft account is frozen. Possible values: '1' - frozen (overdraft transactions are blocked); '0' - not frozen"}},"required":["ActualWithPrimary","Available","Frozen","Limit","OverdraftAccountNo","Payback","PaybackWithPendingFees","RawBalance","RawLimit"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.12,\n \"response_data\": {\n \"OverdraftAccountNo\": \"245101000066\",\n \"Available\": 175,\n \"Payback\": 0,\n \"PaybackWithPendingFees\": 0,\n \"RawBalance\": 175,\n \"ActualWithPrimary\": 993.5,\n \"Limit\": 300,\n \"RawLimit\": 300,\n \"Frozen\": \"0\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"7AUB5DE1WS408K9U5GXM\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:31:58\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.131\n \n 245101000066\n 175\n 0\n 0\n 175\n 993.5\n 300\n 300\n 0\n \n \n \n \n YFTLY4QW8HMJEAN7BALF\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:27:19\n"}}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PRN or PAN\nExample: `\"074103447228\"`","example":"074103447228"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Overdraft"],"summary":"Get Overdraft Balance","parameters":[],"description":"Use the Get Overdraft Balance endpoint to retrieve overdraft-related information such as available overdraft limit, payback amount, and <> balance including overdraft.\n\nFor `accountNo` you can use the <> or <> of the core account that is associated with the overdraft account or the PRN of the overdraft account.","operationId":"post_getoverdraftbalance"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/startEnrollment":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"prodId":{"type":"integer","format":"int32","minimum":0,"maximum":100000000,"description":"A unique product identifier from SoFi Tech Solutions. If this ID is for a business product then `businessName` is **required**.\nPattern: Integer\nExample: `501`","example":501},"id":{"type":"string","nullable":true,"description":"The value of the primary identifier that is specified in `idType`. Product settings determine whether this ID should be unique across the program or product. This parameter is **required** when using the SoFi Tech Solutions legacy <> solution. The system converts all letters to lowercase.\nPattern: As specified in the **Layout** column of the Customer ID Types enumeration\nExample: `\"123456789\"`","example":"123456789"},"idType":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of primary identifier in the `id` parameter. This parameter is **required** when `id` is populated. See the **`idType`** column in the Customer ID Types table for valid values.\nPattern: Integer\nExample: `2`","example":2},"id2":{"type":"string","nullable":true,"description":"Secondary identifier for an account holder. The system converts all letters to lowercase.\nPattern: See Customer ID Types\nExample: `\"123456789012|ut|12/25/2020\"`","example":"123456789012|ut|12/25/2020"},"idType2":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of identifier in `id2`. This parameter is **required** when `id2` is populated. See the **`idType`** column in the Customer ID Types table for valid values.\nPattern: Integer\nExample: `1`","example":1},"location":{"type":"string","nullable":true,"maximum":20,"description":"Unique location identifier (`location`) as returned by the Create Location endpoint. This value is also returned by the Get Locations endpoint depending on the value of `locationType` when the location was created:\n* `0` or `2` — Returned in the `location_id` field\n* `1` — Returned in the `provider_specified_id` field\n\nPattern: Integer if `locationType: 0` or `locationType: 2`; max 15 characters if `locationType: 1`\nExample: `\"a455-3483\"`","example":"a455-3483"},"locationType":{"type":"integer","format":"int32","enum":[0,1,2],"nullable":true,"description":"Type of ID in `location`:\n* `0` — SoFi Tech Solutions location ID\n* `1` — Partner location ID\n* `2` — Don't validate\n\nPattern: Integer\nExample: `1`","example":1},"locale":{"type":"string","default":"en_US","enum":["en_US","es_US","en_CA","fr_CA","es_MX","en_MX"],"nullable":true,"description":"The account holder language and localization preference. If the account holder address is outside the U.S., pass a non `_US` value for this parameter to disable U.S. address validation.\nPattern: String\nExample: `\"en_US\"`","example":"en_US"},"firstName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's first name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Ed\"`","example":"Ed"},"middleName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's middle name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"W\"`","example":"W"},"lastName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's last name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Harley\"`","example":"Harley"},"dateOfBirth":{"type":"string","format":"date-time","nullable":true,"description":"Account holder's birth date. This date is compared with the DOB product parameter when there is a minimum age requirement on the account.\nPattern: YYYY-MM-DD\nExample: `\"1980-01-01\"`","example":"1980-01-01"},"address1":{"type":"string","nullable":true,"description":"Account holder's first address line. Cannot be a P.O. box. Validation rules for `address1`.\nPattern: 4–40 alphanumeric characters\nExample: `\"33 Maple Street\"`","example":"33 Maple Street"},"address2":{"type":"string","nullable":true,"description":"Account holder's second address line. \nPattern: Max 40 alphanumeric characters and address symbols\nExample: `\"#4B\"`","example":"#4B"},"address3":{"type":"string","nullable":true,"description":"Account holder's third address line. \nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Carrera Central\"`","example":"Carrera Central"},"address4":{"type":"string","nullable":true,"description":"Account holder's fourth address line.\nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Barrio El Alhambra\"`","example":"Barrio El Alhambra"},"address5":{"type":"string","nullable":true,"description":"Account holder's fifth address line. \nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Piso 3\"`","example":"Piso 3"},"city":{"type":"string","nullable":true,"description":"Account holder's city.\nPattern: Max 30 characters: letters, spaces, hyphen and period\nExample: `\"Salt Lake City\"`","example":"Salt Lake City"},"state":{"type":"string","nullable":true,"description":"Account holder's state or province. \nPattern: String\nExample: `\"UT\"`","example":"UT"},"postalCode":{"type":"string","nullable":true,"minimum":4,"maximum":10,"pattern":"^[a-zA-Z0-9\\-\\ ]*$","description":"Account holder's postal code (ZIP code).\nPattern: `12345`, `12345-1234`, or `K1A-1A1`\nExample: `\"84121\"`","example":"84121"},"countryCode":{"type":"string","nullable":true,"pattern":"^\\d{3}$","description":"Account holder's country. Three-digit UN M49 code, such as `840` for USA, `124` for Canada, `484` for Mexico, `170` for Colombia.\nPattern: 3-digit number\nExample: `\"840\"`","example":"840"},"expressMail":{"type":"string","enum":["0","1","2","3","4","5","6","7","8","9","Y","N"],"nullable":true,"description":"The type of shipping for the physical card associated with this account. These values are universal across all vendors:\n- `1` — Standard shipping\n- `2` — Express shipping\n- `4` — Bulk shipping\n\nLegacy values `Y` = `2` and `N` = `1`. Consult your emboss vendor for other values. \nPattern: String\nExample: `\"2\"`","example":"2"},"primaryPhone":{"type":"string","nullable":true,"pattern":"^([0-9]+)$","description":"Account holder's primary phone number.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\nExample: `\"8013656060\"`","example":"8013656060"},"otherPhone":{"type":"string","nullable":true,"pattern":"^([0-9]+)$","description":"Account holder's secondary phone number.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\nExample: `\"8013656060\"`","example":"8013656060"},"mobilePhone":{"type":"string","nullable":true,"pattern":"^([0-9]+)$","description":"Account holder's mobile phone number.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\nExample: `\"8013656060\"`","example":"8013656060"},"mobileCarrierId":{"type":"string","nullable":true,"description":"Account holder's mobile carrier. Configurable list.\nPattern: Configurable list\nExample: `\"8\"`","example":"8"},"email":{"type":"string","format":"email","nullable":true,"minLength":3,"maxLength":63,"description":"Account holder's email. This field is validated by Marshmallow.\nPattern: Email address, 3–63 characters\nExample: `\"user@fakedomain.com\"`","example":"user@fakedomain.com"},"webUid":{"type":"string","nullable":true,"minimum":4,"maximum":30,"pattern":"^[a-zA-Z0-9]+(?:[_-][a-zA-Z0-9]+)*$","description":"Account holder's username for the website hosted by SoFi Tech Solutions. Must be unique across the program.\nPattern: Alphanumeric, with first character a letter; case insensitive\nExample: `\"eharley\"`","example":"eharley"},"webPwd":{"type":"string","nullable":true,"description":"Account holder's password for the website hosted by SoFi Tech Solutions.\nPattern: Min 8 characters: must include upper-case character, lower-case character, and a number\nExample: `\"4j9KH3kkdh\"`","example":"4j9KH3kkdh"},"secretQuestion":{"type":"string","nullable":true,"maximum":50,"pattern":"^[A-Za-z0-9_\\'\\s\\?]*$","description":"Account holder's secret question for the website hosted by SoFi Tech Solutions.\nPattern: Max 50 characters: letters, spaces, `?`\nExample: `\"What was the name of your first pet?\"`","example":"What was the name of your first pet?"},"secretAnswer":{"type":"string","nullable":true,"maximum":50,"description":"Account holder's answer to `secretQuestion`.\nPattern: Max 50 characters: letters, spaces, `?`\nExample: `\"Larry\"`","example":"Larry"},"userData":{"type":"string","nullable":true,"maximum":50,"pattern":"^[a-zA-Z0-9_ ]*$","description":"Data supplied by the provider, from sources external to the system. This data will be stored in the system in association with this account. The most common use of this parameter is to track affiliate-marketing traffic. The data in this field can be added to an <>.\nPattern: Max 50 alphanumeric characters, spaces, and underscores\nExample: `\"abcd_1234\"`","example":"abcd_1234"},"verifyOnly":{"type":"integer","format":"int32","enum":[0,1],"nullable":true,"description":"Pass `1` to test the validity of the parameter data without committing the information to the system.\nPattern: Integer\nExample: `1`","example":1},"monthlyIncome":{"type":"number","format":"float","nullable":true,"minimum":0.01,"maximum":999999999999.99,"description":"Currency amounts passed as whole or fractional amounts, examples: '100.00', '100', or '100.73'. \nPattern: Monetary amount 0 or greater.\nExample: `25.50`","example":25.5},"monthlyLiab":{"type":"number","format":"float","nullable":true,"minimum":0.01,"maximum":999999999999.99,"description":"Currency amounts passed as whole or fractional amounts, examples: '100.00', '100', or '100.73'. \nPattern: Monetary amount 0 or greater.\nExample: `25.50`","example":25.5},"runCip":{"type":"integer","format":"int32","enum":[0,1],"nullable":true,"description":"Specifies whether to run <> on the customer. Valid only when using the SoFi Tech Solutions legacy CIP solution.\n* `0` — Do not run CIP\n* `1` — Run CIP\n\nPattern: Integer\nExample: `1`","example":1},"businessName":{"type":"string","nullable":true,"description":"Account holder's business name. This field is **required** if `prodId` is a business product.\nPattern: 2–150 characters. See the supported character set.\nExample: `\"Ed%26Ted\"`","example":"Ed","pattern":"^[A-Za-z0-9_\\s\\'-\\.,\\?@&\\!#~\\*;\\+ '-]*$"},"mobilePhoneCountryCode":{"type":"string","nullable":true,"minimum":2,"maximum":4,"pattern":"^\\+[0-9]*$","description":"Account holder's mobile phone country code.\nPattern: A plus sign followed by 1–3 digits. See Phone Validation for valid values. \nExample: `\"+1\"`","example":"+1"}},"required":["prodId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Start Enrollment","description":"Use the Start Enrollment endpoint to initiate a new enrollment and run <>. This endpoint is not integrated with <>. This endpoint is different from Create Account in that it creates a customer record but does not create an account or card.\n\n> 📘 Note\n> \n> If this endpoint returns a status code that does not match a status code that is specific to this endpoint, it may be an enrollment status code. See Enrollment Statuses for more information.\n\n","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"appId":{"type":"string","description":"Identifier for the enrollment application"},"cip":{"type":"array","items":{"description":"List of cardholder identification process (CIP) objects","type":"object","properties":{"status":{"type":"string","description":"Status of the CIP process"},"model_results":{"type":"array","nullable":true,"description":"_Legacy CIP only_. List of model objects","items":{"type":"object","properties":{"model_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. The model name"},"model_version":{"type":"integer","format":"int32","nullable":true,"description":"_Legacy CIP only_. Version number for the model used"},"code":{"type":"string","nullable":true,"description":"_Legacy CIP only_. In a model run, lists the pass number"},"text":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Plaintext description of the code value"}},"required":["code","model_name","model_version","text"]}},"date_time":{"type":"string","format":"date-time","description":"_Legacy CIP only_. The date and time CIP was run"},"first_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's first name"},"middle_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's middle name"},"last_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's last name"},"address_1":{"type":"string","nullable":true,"description":"_Legacy CIP only_. First line of the account holder's address"},"address_2":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Second line of the account holder's address"},"city":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's city"},"state":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's state"},"primary_phone":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's primary phone number"},"other_phone":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's other phone number"}},"required":["date_time","model_results","status"]}},"max_credit_limit":{"type":"string","description":"Maximum credit limit"}},"required":["appId"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.08,\n \"response_data\": {\n \"appId\": \"477477\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"XPEED783YA5LKFXO80D1\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:38:07\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.077\n \n 477784\n \n \n \n \n D6GG9F4GFW1AL0Z8BNGN\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:29:25\n"}}}},"description":""}},"operationId":"post_startenrollment"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getEnrollmentInfo":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"}},"required":["transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Get Enrollment Info","description":"Use Get Enrollment Info to get the customer data that was submitted with Start Enrollment or with a Create Account call that passed `cipStatus: 1` (send customer profile to <> but do not create account). The endpoint returns customer data and any CIP-related information. This endpoint is not integrated with <>.\n\nPass the `transactionId` from the original Start Enrollment or Create Account call. No other parameters except the base form parameters are required.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"enrollment_data":{"description":"A data structure for enrollment information","type":"object","properties":{"first_name":{"type":"string","nullable":true,"description":"Account holder's first name"},"middle_name":{"type":"string","nullable":true,"description":"Account holder's middle name"},"last_name":{"type":"string","nullable":true,"description":"Account holder's last name"},"address_1":{"type":"string","nullable":true,"description":"First line of the account holder's address"},"address_2":{"type":"string","nullable":true,"description":"Second line of the account holder's address"},"city":{"type":"string","nullable":true,"description":"Account holder's city"},"state":{"type":"string","nullable":true,"description":"Account holder's state"},"postal_code":{"type":"string","nullable":true,"description":"Account holder's postal code"},"country_code":{"type":"string","nullable":true,"description":"The ISO 3166 international standard for country codes. Identifies the account holder's country."},"primary_phone":{"type":"string","nullable":true,"description":"Account holder's primary phone number"},"mobile_phone":{"type":"string","nullable":true,"description":"Account holder's mobile phone number"},"other_phone":{"type":"string","nullable":true,"description":"Account holder's other phone number"},"web_uid":{"type":"string","nullable":true,"description":"Account holder's user name (if SoFi Tech Solutions hosts the enrollment website)"},"secret_question":{"type":"string","nullable":true,"description":"A secret question associated with the account for access verification"},"id":{"type":"string","nullable":true,"description":"The customer ID type"},"idType":{"type":"integer","format":"int32","nullable":true,"description":"Description of the ID type specified in the `id` response field"},"id2":{"type":"string","nullable":true,"description":"The customer ID type for a secondary ID"},"idType2":{"type":"integer","format":"int32","nullable":true,"description":"Description of the ID type specified in the `id2` response field"}},"required":["address_1","address_2","city","country_code","first_name","id","id2","idType","idType2","last_name","middle_name","mobile_phone","other_phone","postal_code","primary_phone","secret_question","state","web_uid"]},"cip":{"type":"array","items":{"description":"List of cardholder identification process (CIP) objects","type":"object","properties":{"status":{"type":"string","description":"Status of the CIP process"},"model_results":{"type":"array","nullable":true,"description":"_Legacy CIP only_. List of model objects","items":{"type":"object","properties":{"model_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. The model name"},"model_version":{"type":"integer","format":"int32","nullable":true,"description":"_Legacy CIP only_. Version number for the model used"},"code":{"type":"string","nullable":true,"description":"_Legacy CIP only_. In a model run, lists the pass number"},"text":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Plaintext description of the code value"}},"required":["code","model_name","model_version","text"]}},"date_time":{"type":"string","format":"date-time","description":"_Legacy CIP only_. The date and time CIP was run"},"first_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's first name"},"middle_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's middle name"},"last_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's last name"},"address_1":{"type":"string","nullable":true,"description":"_Legacy CIP only_. First line of the account holder's address"},"address_2":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Second line of the account holder's address"},"city":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's city"},"state":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's state"},"primary_phone":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's primary phone number"},"other_phone":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's other phone number"}},"required":["date_time","model_results","status"]}}},"required":["cip","enrollment_data"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.028,\n \"response_data\": {\n \"enrollment_data\": {\n \"first_name\": \"Jerome\",\n \"middle_name\": \"T\",\n \"last_name\": \"Pushey\",\n \"address_1\": \"6510 S Millrock Dr\",\n \"address_2\": \"Suite 300\",\n \"city\": \"Salt Lake City\",\n \"state\": \"UT\",\n \"postal_code\": \"84121\",\n \"country_code\": null,\n \"primary_phone\": null,\n \"mobile_phone\": \"8013650000\",\n \"other_phone\": null,\n \"web_uid\": \"jpushey\",\n \"secret_question\": \"What is your mother's maiden name?\",\n \"id\": \"987451235\",\n \"idType\": \"2\",\n \"id2\": null,\n \"idType2\": null\n },\n \"cip\": []\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"testtransid\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 14:30:38\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.024\n \n \n Jerome\n T\n Pushey\n 6510 S Millrock Dr\n Suite 300\n Salt Lake City\n UT\n 84121\n \n \n 8013650000\n \n jpushey\n What is your mother's maiden name?\n 987451235\n 2\n \n \n \n \n \n \n \n \n testtransid\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 14:30:39\n"}}}},"description":""}},"operationId":"post_getenrollmentinfo"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/updateEnrollment":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"prodId":{"type":"integer","format":"int32","minimum":0,"maximum":100000000,"description":"A unique product identifier from SoFi Tech Solutions. If this ID is for a business product then `businessName` is **required**.\nPattern: Integer\nExample: `501`","example":501},"id":{"type":"string","nullable":true,"description":"Primary identifier for an account holder. The system converts all letters to lowercase.\nPattern: See Customer ID Types\nExample: `\"123456789\"`","example":"123456789"},"idType":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of primary identifier in the `id` parameter. This parameter is **required** when `id` is populated. See the **`idType`** column in the Customer ID Types table for valid values.\nPattern: Integer\nExample: `2`","example":2},"id2":{"type":"string","nullable":true,"description":"Secondary identifier for an account holder. The system converts all letters to lowercase.\nPattern: See Customer ID Types\nExample: `\"123456789012|ut|12/25/2020\"`","example":"123456789012|ut|12/25/2020"},"idType2":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of identifier in `id2`. This parameter is **required** when `id2` is populated. See the **`idType`** column in the Customer ID Types table for valid values.\nPattern: Integer\nExample: `1`","example":1},"firstName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's first name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Ed\"`","example":"Ed"},"middleName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's middle name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"W\"`","example":"W"},"lastName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's last name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Harley\"`","example":"Harley"},"dateOfBirth":{"type":"string","format":"date-time","nullable":true,"description":"Account holder's birth date. This date is compared with the DOB product parameter when there is a minimum age requirement on the account.\nPattern: YYYY-MM-DD\nExample: `\"1980-01-01\"`","example":"1980-01-01"},"address1":{"type":"string","nullable":true,"description":"Account holder's first address line. Cannot be a P.O. box. Validation rules for `address1`.\nPattern: 4–40 alphanumeric characters\nExample: `\"33 Maple Street\"`","example":"33 Maple Street"},"address2":{"type":"string","nullable":true,"description":"Account holder's second address line. \nPattern: Max 40 alphanumeric characters and address symbols\nExample: `\"#4B\"`","example":"#4B"},"address3":{"type":"string","nullable":true,"description":"Account holder's third address line. \nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Carrera Central\"`","example":"Carrera Central"},"address4":{"type":"string","nullable":true,"description":"Account holder's fourth address line.\nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Barrio El Alhambra\"`","example":"Barrio El Alhambra"},"address5":{"type":"string","nullable":true,"description":"Account holder's fifth address line. \nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Piso 3\"`","example":"Piso 3"},"locale":{"type":"string","default":"en_US","enum":["en_US","es_US","en_CA","fr_CA","es_MX","en_MX"],"nullable":true,"description":"The account holder language and localization preference. If the account holder address is outside the U.S., pass a non `_US` value for this parameter to disable U.S. address validation.\nPattern: String\nExample: `\"en_US\"`","example":"en_US"},"city":{"type":"string","nullable":true,"description":"Account holder's city.\nPattern: Max 30 characters: letters, spaces, hyphen and period\nExample: `\"Salt Lake City\"`","example":"Salt Lake City"},"state":{"type":"string","nullable":true,"description":"Account holder's state or province. \nPattern: String\nExample: `\"UT\"`","example":"UT"},"postalCode":{"type":"string","nullable":true,"minimum":4,"maximum":10,"pattern":"^[a-zA-Z0-9\\-\\ ]*$","description":"Account holder's postal code (ZIP code).\nPattern: `12345`, `12345-1234`, or `K1A-1A1`\nExample: `\"84121\"`","example":"84121"},"countryCode":{"type":"string","nullable":true,"pattern":"^\\d{3}$","description":"Account holder's country. Three-digit UN M49 code, such as `840` for USA, `124` for Canada, `484` for Mexico, `170` for Colombia.\nPattern: 3-digit number\nExample: `\"840\"`","example":"840"},"primaryPhone":{"type":"string","nullable":true,"pattern":"^([0-9]+|null)$","description":"Account holder's primary phone number.\nPattern: Exactly 10 digits, no hyphens or other characters\nExample: `\"8013656060\"`","example":"8013656060"},"otherPhone":{"type":"string","nullable":true,"pattern":"^([0-9]+|null)$","description":"Phone number.\nPattern: Exactly 10 digits, no hyphens or other characters\nExample: `\"8013656060\"`","example":"8013656060"},"mobilePhone":{"type":"string","nullable":true,"pattern":"^([0-9]+|null)$","description":"Phone number.\nPattern: Exactly 10 digits, no hyphens or other characters\nExample: `\"8013656060\"`","example":"8013656060"},"mobileCarrierId":{"type":"string","nullable":true,"description":"Account holder's mobile carrier. Configurable list.\nPattern: Configurable list\nExample: `\"8\"`","example":"8"},"email":{"type":"string","format":"email","nullable":true,"minLength":3,"maxLength":63,"description":"Account holder's email. This field is validated by Marshmallow.\nPattern: Email address, 3–63 characters\nExample: `\"user@fakedomain.com\"`","example":"user@fakedomain.com"},"webUid":{"type":"string","nullable":true,"minimum":4,"maximum":30,"pattern":"^[a-zA-Z0-9]+(?:[_-][a-zA-Z0-9]+)*$","description":"Account holder's username for the website hosted by SoFi Tech Solutions. Must be unique across the program.\nPattern: Alphanumeric, with first character a letter; case insensitive\nExample: `\"eharley\"`","example":"eharley"},"webPwd":{"type":"string","nullable":true,"description":"Account holder's password for the website hosted by SoFi Tech Solutions.\nPattern: Min 8 characters: must include upper-case character, lower-case character, and a number\nExample: `\"4j9KH3kkdh\"`","example":"4j9KH3kkdh"},"secretQuestion":{"type":"string","nullable":true,"maximum":50,"pattern":"^[A-Za-z0-9_\\'\\s\\?]*$","description":"Account holder's secret question for the website hosted by SoFi Tech Solutions.\nPattern: Max 50 characters: letters, spaces, `?`\nExample: `\"What was the name of your first pet?\"`","example":"What was the name of your first pet?"},"secretAnswer":{"type":"string","nullable":true,"maximum":50,"description":"Account holder's answer to `secretQuestion`.\nPattern: Max 50 characters: letters, spaces, `?`\nExample: `\"Larry\"`","example":"Larry"},"monthlyIncome":{"type":"number","format":"float","default":0,"nullable":true,"minimum":0,"maximum":9999999999,"description":"Monthly income for the account holder.\nPattern: Float between 0 and 9999999999\nExample: `3400.00`","example":25.99},"monthlyLiab":{"type":"number","format":"float","default":0,"nullable":true,"minimum":0,"maximum":999999999999.99,"description":"Currency amount as a whole or decimal amount.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`","example":25.99},"businessName":{"type":"string","nullable":true,"description":"Account holder's business name. This field is **required** if `prodId` is a business product.\nPattern: 2–150 characters. See the supported character set.\nExample: `\"Ed%26Ted\"`","example":"Ed","pattern":"^[A-Za-z0-9_\\s\\'-\\.,\\?@&\\!#~\\*;\\+ '-]*$"}},"required":["transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Update Enrollment","description":"Use the Update Enrollment endpoint to update customer profile information for an enrollment that was created using Start Enrollment.\n\n> 📘 Note\n> \n> Validation on an SSN is limited to a length check.\n\n","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"max_credit_limit":{"type":"string","description":"Maximum credit limit"}}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.081,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"GXC81KW7MEF297N9OQGV\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:38:13\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 2025-07-13 10:38:13\n \n 0.081\n \n GXC81KW7MEF297N9OQGV\n \n \n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n"}}}},"description":""}},"operationId":"post_updateenrollment"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/verifyEnrollment":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"id":{"type":"string","nullable":true,"description":"The value of the primary identifier that is specified in `idType`. Product settings determine whether this ID should be unique across the program or product. This parameter is **required** when using the SoFi Tech Solutions legacy <> solution. The system converts all letters to lowercase.\nPattern: As specified in the **Layout** column of the Customer ID Types enumeration\nExample: `\"123456789\"`","example":"123456789"},"idType":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of primary identifier in the `id` parameter. This parameter is **required** when `id` is populated. See the **`idType`** column in the Customer ID Types table for valid values.\nPattern: Integer\nExample: `2`","example":2}},"required":["transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Verify Enrollment","description":"Use the Verify Enrollment endpoint to look up an existing enrollment by `transactionId` or `id` to view information and status. The endpoint returns enrollment data, enrollment date, and `transactionID` of the initial enrollment, when the enrollment was initiated with the Start Enrollment or Create Account endpoint.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"processed_date":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp for when the response data was processed"},"app_trans_id":{"type":"string","format":"date-time","nullable":true,"description":"Identifier for the enrollment application"},"max_credit_limit":{"type":"number","format":"float","nullable":true,"description":"Maximum credit limit"},"application":{"description":"A data structure for the information contained in an application","type":"object","properties":{"appId":{"type":"string","description":"Identifier for the enrollment application"},"appDate":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp for the application transaction"},"prodId":{"type":"integer","format":"int32","description":"Identifier for the product associated with the account"},"id":{"type":"string","nullable":true,"description":"The customer ID type"},"idType":{"type":"integer","format":"int32","nullable":true,"description":"Description of the ID type specified in the `id` response field"},"id2":{"type":"string","nullable":true,"description":"The customer ID type for a secondary ID"},"idType2":{"type":"integer","format":"int32","nullable":true,"description":"Description of the ID type specified in the `id2` response field"},"locale":{"type":"string","nullable":true,"description":"The account holder's language and localization preference"},"firstName":{"type":"string","nullable":true,"description":"Account holder's first name"},"middleName":{"type":"string","nullable":true,"description":"Account holder's middle name"},"lastName":{"type":"string","nullable":true,"description":"Account holder's last name"},"dateOfBirth":{"type":"string","nullable":true,"description":"Account holder's date of birth"},"address1":{"type":"string","nullable":true,"description":"First line of the account holder's address"},"address2":{"type":"string","nullable":true,"description":"Second line of the account holder's address"},"city":{"type":"string","nullable":true,"description":"Account holder's city"},"state":{"type":"string","nullable":true,"description":"Account holder's state"},"postalCode":{"type":"string","nullable":true,"description":"Account holder's postal code"},"expressMail":{"type":"string","nullable":true,"description":"Indicates which express mail value has been set for this card "},"primaryPhone":{"type":"string","nullable":true,"description":"Account holder's primary phone number"},"mobilePhone":{"type":"string","nullable":true,"description":"Account holder's mobile phone number"},"mobileCarrierId":{"type":"string","nullable":true,"description":"Identifier for the mobile phone service provider"},"otherPhone":{"type":"string","nullable":true,"description":"Account holder's other phone number"},"email":{"type":"string","nullable":true,"description":"Account holder's email address"},"userData":{"type":"string","nullable":true,"description":"Data associated with the account that you supply. This data is external to the system."},"monthlyIncome":{"type":"string","nullable":true,"description":"Account holder's gross income for one month"},"monthlyLiab":{"type":"string","nullable":true,"description":"Account holder's total liabilities for one month"}},"required":["address1","address2","appDate","appId","city","dateOfBirth","email","expressMail","firstName","id","id2","idType","idType2","lastName","locale","middleName","mobileCarrierId","mobilePhone","monthlyIncome","monthlyLiab","otherPhone","postalCode","primaryPhone","prodId","state","userData"]}},"required":["app_trans_id","application","processed_date"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.029,\n \"response_data\": {\n \"processed_date\": null,\n \"app_trans_id\": \"06077879-1451-4dd8-a0bc-23de1ab5490a\",\n \"application\": {\n \"appId\": \"2132395\",\n \"appDate\": \"2025-07-15 14:09:58\",\n \"prodId\": \"11981\",\n \"idType\": \"2\",\n \"id\": \"987451235\",\n \"idType2\": \"\",\n \"id2\": \"\",\n \"locale\": \"EN\",\n \"firstName\": \"Jerome\",\n \"middleName\": \"T\",\n \"lastName\": \"Pushey\",\n \"dateOfBirth\": \"1951-05-12\",\n \"address1\": \"6510 S Millrock Dr\",\n \"address2\": \"Suite 300\",\n \"city\": \"Salt Lake City\",\n \"state\": \"UT\",\n \"postalCode\": \"84121\",\n \"expressMail\": \"1\",\n \"primaryPhone\": \"\",\n \"otherPhone\": \"\",\n \"mobilePhone\": \"8013650000\",\n \"mobileCarrierId\": \"6\",\n \"email\": \"jpushey@tech.sofi.com\",\n \"userData\": \"\",\n \"monthlyIncome\": \"5000\",\n \"monthlyLiab\": \"1000\"\n }\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"06077879-1451-4dd8-a0bc-23de1ab5490a\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 15:08:45\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.029\n \n \n 06077879-1451-4dd8-a0bc-23de1ab5490a\n \n 2132397\n 2025-07-15 14:09:59\n 11981\n 2\n 987451235\n \n \n EN\n Jerome\n T\n Pushey\n 1951-05-12\n 6510 S Millrock Dr\n Suite 300\n Salt Lake City\n UT\n 84121\n 1\n \n \n 8013650000\n 6\n jpushey@tech.sofi.com\n \n 5000\n 1000\n \n \n \n \n \n 06077879-1451-4dd8-a0bc-23de1ab5490a\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 15:08:46\n"}}}},"description":""}},"operationId":"post_verifyenrollment"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/completeEnrollment":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"location":{"type":"string","nullable":true,"maximum":20,"description":"Unique location identifier (`location`) as returned by the Create Location endpoint. This value is also returned by the Get Locations endpoint depending on the value of `locationType` when the location was created:\n* `0` or `2` — Returned in the `location_id` field\n* `1` — Returned in the `provider_specified_id` field\n\nPattern: Integer if `locationType: 0` or `locationType: 2`; max 15 characters if `locationType: 1`\nExample: `\"a455-3483\"`","example":"a455-3483"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PRN or PAN\nExample: `\"074103447228\"`","example":"074103447228"},"prodId":{"type":"integer","format":"int32","minimum":0,"maximum":100000000,"description":"A unique product identifier from SoFi Tech Solutions. If this ID is for a business product then `businessName` is **required**.\nPattern: Integer\nExample: `501`","example":501},"locationType":{"type":"integer","format":"int32","enum":[0,1,2],"nullable":true,"description":"Type of ID in `location`:\n* `0` — SoFi Tech Solutions location ID\n* `1` — Partner location ID\n* `2` — Don't validate\n\nPattern: Integer\nExample: `1`","example":1},"sharedBalance":{"type":"integer","format":"int32","enum":[0,1],"nullable":true,"description":"Specifies whether the secondary account will share the balance of the primary account. This parameter is **required** when `primaryAccount` is populated. Do not set this parameter to `1` when `primaryAccount` is not populated.\n* `0` — Do not share the balance\n* `1` — Share the balance\n\nPattern: Integer\nExample: `1`","example":1},"offline":{"type":"integer","format":"int32","enum":[0,1],"nullable":true,"description":"Pass `1` for an offline transaction.\nPattern: Integer\nExample: `1`","example":1},"primaryAccount":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"<> or <> of the primary account to associate this account with. Populate this parameter only when creating a secondary account.\nPattern: PAN or PRN\nExample: `\"123456789012\"`","example":"074103447228"},"externalAccountId":{"type":"string","nullable":true,"maximum":30,"pattern":"^[a-zA-Z0-9\\-]*$","description":"User-supplied identifier that is related to an external system. This ID is stored in the system in association with this account and can be provided in the <>s.\nPattern: Max 30 alphanumeric characters. Lowercase only.\nExample: `\"553b45sbs\"`","example":"553b45sbs"},"embossLine2":{"type":"string","nullable":true,"maximum":28,"pattern":"^[a-zA-Z0-9_\\s\\'\"!\\?]*$","description":"Second line to emboss on the card.\nPattern: Supported characters\nExample: `\"Scarlet Ibis Shipping\"`","example":"Scarlet Ibis Shipping"},"fundingAccountNo":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12})$","description":"PRN of the <> funding account. **Required** if `prodId` is an RTF spending product.\nPattern: 12-digit numeric string\nExample: `\"143101204201\"`","example":"143101204201"}},"required":["prodId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Complete Enrollment","description":"Use the Complete Enrollment endpoint to finalize an incomplete enrollment that was begun by Start Enrollment or Create Account. You must pass the same `transactionId` as the original Start Enrollment or Create Account request.\n\n> 📘 Note\n> \n> If this endpoint returns a status code that does not match a status code that is specific to this endpoint, it may be an enrollment status code. See Enrollment Statuses for more information.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"new_account":{"description":"Acts as a logical separator if multiple accounts are created with the same request","type":"object","properties":{"pmt_ref_no":{"type":"string","description":"Payment reference number."},"product_id":{"type":"string","description":"Identifier for the product associated with the account"},"galileo_account_number":{"type":"string","description":"System-generated balance ID"},"card_id":{"type":"string","nullable":true,"description":"System-generated card identifier (CAD). Use this ID instead of the PAN if not PCI-compliant. `None` means that no card was created"},"cip":{"type":"array","nullable":true,"description":"List of cardholder identification process (CIP) objects","items":{"type":"object","properties":{"status":{"type":"string","description":"Status of the CIP process"},"model_results":{"type":"array","description":"List of model objects","items":{"type":"object","properties":{"model_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. The model name"},"model_version":{"type":"integer","format":"int32","nullable":true,"description":"_Legacy CIP only_. Version number for the model used"},"code":{"type":"string","nullable":true,"description":"_Legacy CIP only_. In a model run, lists the pass number"},"text":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Plaintext description of the code value"}},"required":["code","model_name","model_version","text"]}},"date_time":{"type":"string","format":"date-time","description":"The date and time CIP was run"}},"required":["date_time","model_results","status"]}}},"required":["card_id","cip","galileo_account_number","pmt_ref_no","product_id"]}},"required":["new_account"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.279,\n \"response_data\": [\n {\n \"pmt_ref_no\": \"999800025640\",\n \"product_id\": \"2222\",\n \"galileo_account_number\": \"5012357\",\n \"cip\": null,\n \"card_id\": \"14861156\"\n }\n ],\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"dd5c35ba-bf80-4058-9e03-203388a31395\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 13:41:55\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.279\n \n - \n 999800025640\n 2222\n 5012357\n \n 14861156\n
\n \n \n \n \n dd5c35ba-bf80-4058-9e03-203388a31395\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2027-07-15 13:41:55\n\n"}}}},"description":""}},"operationId":"post_completeenrollment"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/runEnrollmentCip":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"id":{"type":"string","nullable":true,"description":"The value of the primary identifier that is specified in `idType`. Product settings determine whether this ID should be unique across the program or product. This parameter is **required** when using the SoFi Tech Solutions legacy <> solution. The system converts all letters to lowercase.\nPattern: As specified in the **Layout** column of the Customer ID Types enumeration\nExample: `\"123456789\"`","example":"123456789"},"idType":{"type":"integer","format":"int32","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of primary identifier in the `id` parameter. This parameter is **required** when `id` is populated. See the **ID** column in the Customer ID Types table for valid values.\nPattern: 1- or 2-digit integer\nExample: `\"123456789\"`","example":"123456789"}},"required":["transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Run Enrollment CIP","description":"Use the Run Enrollment CIP endpoint to run or re-run the <> process on an existing customer. This endpoint is not integrated with <>. \n\n> 📘 Note\n> \n> Validation on an SSN is limited to a length check.\n\n","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information. ","type":"object","properties":{"cip":{"type":"array","items":{"description":"List of cardholder identification process (CIP) objects","type":"object","properties":{"status":{"type":"string","description":"Status of the CIP process"},"model_results":{"type":"array","nullable":true,"description":"_Legacy CIP only_. List of model objects","items":{"type":"object","properties":{"model_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. The model name"},"model_version":{"type":"integer","format":"int32","nullable":true,"description":"_Legacy CIP only_. Version number for the model used"},"code":{"type":"string","nullable":true,"description":"_Legacy CIP only_. In a model run, lists the pass number"},"text":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Plaintext description of the code value"}},"required":["code","model_name","model_version","text"]}},"date_time":{"type":"string","format":"date-time","description":"_Legacy CIP only_. The date and time CIP was run"},"first_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's first name"},"middle_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's middle name"},"last_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's last name"},"address_1":{"type":"string","nullable":true,"description":"_Legacy CIP only_. First line of the account holder's address"},"address_2":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Second line of the account holder's address"},"city":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's city"},"state":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's state"},"primary_phone":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's primary phone number"},"other_phone":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's other phone number"}},"required":["date_time","model_results","status"]}}},"required":["cip"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.202,\n \"response_data\": {\n \"cip\": [\n {\n \"status\": \"Pass\",\n \"model_results\": {\n \"model_name\": \"METALN\",\n \"model_version\": \"1\",\n \"code\": \"Pass 01\",\n \"text\": \"SSN Matches Address\"\n },\n \"date_time\": \"2025-07-13 10:38:05\"\n },\n {\n \"status\": \"Pass\",\n \"model_results\": {\n \"model_name\": \"METALN\",\n \"model_version\": \"1\",\n \"code\": \"Pass 01\",\n \"text\": \"SSN Matches Address\"\n },\n \"date_time\": \"2025-07-13 10:38:04\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"R0TW9RF5X6MK9OO3WU57\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:38:05\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 2025-07-13 10:38:05\n \n \n \n Pass\n \n \n METALN\n 1\n Pass 01\n SSN Matches Address\n \n \n 2025-07-13 10:38:05\n \n \n Pass\n \n \n METALN\n 1\n Pass 01\n SSN Matches Address\n \n \n 2025-07-13 10:38:04\n \n \n \n 0.282\n \n 90TWR5X6MUFOR57K9O3W\n \n \n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n"}}}},"description":""}},"operationId":"post_runenrollmentcip"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/runCip":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Run CIP","description":"Use the Run CIP endpoint to run the legacy <> process on a customer who has already been enrolled. Do not use this endpoint if you are using your own CIP provider. This endpoint is not integrated with <>.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"cip_result_indicator":{"type":"string","nullable":true,"description":"A flag that indicates whether a CIP result exists in the response"},"cip_result":{"type":"array","items":{"description":"A data structure that contains data fields around a CIP result","type":"object","properties":{"status":{"type":"string","description":"Status of the CIP process"},"model_results":{"type":"array","nullable":true,"description":"_Legacy CIP only_. List of model objects","items":{"type":"object","properties":{"model_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. The model name"},"model_version":{"type":"integer","format":"int32","nullable":true,"description":"_Legacy CIP only_. Version number for the model used"},"code":{"type":"string","nullable":true,"description":"_Legacy CIP only_. In a model run, lists the pass number"},"text":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Plaintext description of the code value"}},"required":["code","model_name","model_version","text"]}},"date_time":{"type":"string","format":"date-time","description":"_Legacy CIP only_. The date and time CIP was run"},"first_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's first name"},"middle_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's middle name"},"last_name":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's last name"},"address_1":{"type":"string","nullable":true,"description":"_Legacy CIP only_. First line of the account holder's address"},"address_2":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Second line of the account holder's address"},"city":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's city"},"state":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's state"},"primary_phone":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's primary phone number"},"other_phone":{"type":"string","nullable":true,"description":"_Legacy CIP only_. Account holder's other phone number"}},"required":["date_time","model_results","status"]}}},"required":["cip_result","cip_result_indicator"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.202,\n \"response_data\": {\n \"cip_result_indicator\": \"Y\",\n \"cip_result\": [\n {\n \"status\": \"Pass\",\n \"model_results\": {\n \"model_name\": \"BancorpPIDC\",\n \"model_version\": \"1\",\n \"code\": \"Pass A\",\n \"text\": \"Pass A\"\n },\n \"date_time\": \"2025-07-13 10:38:04\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"LTQ4T4G0DMQN5OTQ4C6X\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:38:04\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.218\n \n Y\n \n \n Pass\n \n \n BancorpPIDC\n 1\n Pass A\n Pass A\n \n \n 2025-07-13 12:29:22\n \n \n \n \n \n \n RTV564029YECS7Z8NW98\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:29:22\n"}}}},"description":""}},"operationId":"post_runcip"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/createVirtualCard":{"post":{"summary":"Create Virtual Card Account","description":"Use the Create Virtual Card Account endpoint to create a virtual card account for a new customer. To create any other type of account for a new customer use the Create Account endpoint.\n\nCreate Virtual Account is similar to Create Account except that it accepts only virtual card product IDs for `prodId`. Consult the Creating an Account procedure for instructions on using this endpoint, and consult the Customer ID Verification guide for how to use this endpoint with the SoFi Tech Solutions legacy CIP solution.\n\n[block:callout]\n\n{\n\"type\": \"info\",\n\"title\": \"Note\",\n\"body\": \"You must be PCI-compliant to use this endpoint. If you are not PCI compliant, use the Create Account endpoint and specify a virtual card product for `prodId`.\"\n}\n[/block]\n\n\n\n[block:callout]\n\n{\n\"type\": \"info\",\n\"title\": \"Note\",\n\"body\": \"If this endpoint returns a status code that does not match a status code that is specific to this endpoint, it may be an enrollment status code. See Enrollment Statuses for more information.\"\n}\n[/block]\n\n","parameters":[],"tags":["Accounts and Cards"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency.. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"prodId":{"type":"integer","format":"int32","minimum":0,"maximum":100000000,"description":"A unique product identifier from SoFi Tech Solutions. If this ID is for a business product then `businessName` is **required**.\nPattern: Integer\nExample: `501`","example":501},"id":{"type":"string","nullable":true,"description":"The value of the primary identifier that is specified in `idType`. Product settings determine whether this ID should be unique across the program or product. This parameter is **required** when using the SoFi Tech Solutions legacy <> solution. The system converts all letters to lowercase.\nPattern: As specified in the **Layout** column of the Customer ID Types enumeration\nExample: `\"123456789\"`","example":"123456789"},"idType":{"type":"integer","format":"int32","nullable":true,"minimum":1,"maximum":15,"description":"Specifies the type of primary identifier in the `id` parameter. This parameter is **required** when `id` is populated. See the **ID** column in the Customer ID Types table for valid values.\nPattern: Integer\nExample: `2`","example":2},"id2":{"type":"string","nullable":true,"description":"The value of the secondary identifier that is specified in `idType2`. The system converts all letters to lowercase.\nPattern: As specified in the **Layout** column of the Customer ID Types enumeration\nExample: `\"123456789012|ut|12/25/2020\"`","example":"123456789012|ut|12/25/2020"},"idType2":{"type":"integer","format":"int32","nullable":true,"minimum":1,"maximum":15,"description":"Specifies the type of secondary identifier in the `id2` parameter. This parameter is **required** when `id2` is populated. See the **ID** column in the Customer ID Types table for valid values.\nPattern: Integer\nExample: `1`","example":1},"locale":{"type":"string","enum":["en_US","es_US","en_CA","fr_CA","es_MX","en_MX"],"nullable":true,"description":"The account holder language and localization preference. If the account holder address is outside the U.S., pass a non `_US` value for this parameter to disable U.S. address validation.\nPattern: String\nExample: `\"en_US\"`","example":"en_US"},"firstName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's first name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Ed\"`","example":"Ed"},"middleName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's middle name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"W\"`","example":"W"},"lastName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's last name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Harley\"`","example":"Harley"},"dateOfBirth":{"type":"string","format":"date-time","nullable":true,"description":"Account holder's birth date. This date is compared with the DOB product parameter when there is a minimum age requirement on the account.\nPattern: YYYY-MM-DD\nExample: `\"1980-01-01\"`","example":"1980-01-01"},"address1":{"type":"string","nullable":true,"description":"Account holder's first address line. Cannot be a P.O. box. Validation rules for `address1`.\nPattern: 4–40 alphanumeric characters\nExample: `\"33 Maple Street\"`","example":"33 Maple Street"},"address2":{"type":"string","nullable":true,"description":"Account holder's second address line. \nPattern: Max 40 alphanumeric characters and address symbols\nExample: `\"#4B\"`","example":"#4B"},"address3":{"type":"string","nullable":true,"description":"Account holder's third address line. \nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Carrera Central\"`","example":"Carrera Central"},"address4":{"type":"string","nullable":true,"description":"Account holder's fourth address line. \nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Barrio El Alhambra\"`","example":"Barrio El Alhambra"},"address5":{"type":"string","nullable":true,"description":"Account holder's fifth address line. \nPattern: Max 30 alphanumeric characters and address symbols\nExample: `\"Piso 3\"`","example":"Piso 3"},"city":{"type":"string","nullable":true,"description":"Account holder's city.\nPattern: Max 30 characters: letters, spaces, hyphen and period\nExample: `\"Salt Lake City\"`","example":"Salt Lake City"},"state":{"type":"string","nullable":true,"description":"Account holder's state or province. \nPattern: String\nExample: `\"UT\"`","example":"UT"},"postalCode":{"type":"string","nullable":true,"minimum":4,"maximum":10,"pattern":"^[a-zA-Z0-9\\-\\ ]*$","description":"Account holder's postal code (ZIP code).\nPattern: `12345`, `12345-1234`, or `K1A-1A1`\nExample: `\"84121\"`","example":"84121"},"countryCode":{"type":"string","nullable":true,"pattern":"^\\d{3}$","description":"Account holder's country. Three-digit UN M49 code, such as `840` for USA, `124` for Canada, `484` for Mexico, `170` for Colombia.\nPattern: 3-digit number\nExample: `\"840\"`","example":"840"},"primaryPhone":{"type":"string","nullable":true,"pattern":"^([0-9]+)$","description":"Account holder's primary phone number.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\nExample: `\"8013656060\"`","example":"8013656060"},"otherPhone":{"type":"string","nullable":true,"pattern":"^([0-9]+)$","description":"Account holder's secondary phone number.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\nExample: `\"8013656060\"`","example":"8013656060"},"mobilePhone":{"type":"string","nullable":true,"pattern":"^([0-9]+)$","description":"Account holder's mobile phone number.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\nExample: `\"8013656060\"`","example":"8013656060"},"mobileCarrierId":{"type":"string","nullable":true,"description":"Account holder's mobile carrier. Configurable list.\nPattern: Configurable list\nExample: `\"8\"`","example":"8"},"email":{"type":"string","format":"email","nullable":true,"minLength":3,"maxLength":63,"description":"Account holder's email\nPattern: Email address, 3–63 characters\nExample: `\"user@fakedomain.com\"`","example":"user@fakedomain.com"},"webUid":{"type":"string","nullable":true,"minimum":4,"maximum":30,"pattern":"^[a-zA-Z0-9]+(?:[_-][a-zA-Z0-9]+)*$","description":"Account holder's username for the website hosted by SoFi Tech Solutions. Must be unique across the program.\nPattern: Alphanumeric, with first character a letter; case insensitive\nExample: `\"eharley\"`","example":"eharley"},"webPwd":{"type":"string","nullable":true,"description":"Account holder's password for the website hosted by SoFi Tech Solutions.\nPattern: Min 8 characters: must include upper-case character, lower-case character, and a number\nExample: `\"4j9KH3kkdh\"`","example":"4j9KH3kkdh"},"secretQuestion":{"type":"string","nullable":true,"maximum":50,"pattern":"^[A-Za-z0-9_\\'\\s\\?]*$","description":"Account holder's secret question for the website hosted by SoFi Tech Solutions.\nPattern: Max 50 characters: letters, spaces, `?`\nExample: `\"What was the name of your first pet?\"`","example":"What was the name of your first pet?"},"secretAnswer":{"type":"string","nullable":true,"maximum":50,"description":"Account holder's answer to `secretQuestion`.\nPattern: Max 50 characters: letters, spaces, `?`\nExample: `\"Larry\"`","example":"Larry"},"loadAmount":{"type":"number","format":"float","nullable":true,"minimum":0.01,"maximum":999999999999.99,"description":"Currency amount passed as a whole or decimal amount. Initial load amount on a card must be within product load limits or be the designated amount for an instant-issue card.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100` or `100.73`","example":25.5},"loadType":{"type":"string","nullable":true,"maximum":2,"pattern":"^[a-zA-Z0-9]*$","description":"Transaction type for the `loadAmount`. Use values from your list of load types from SoFi Tech Solutions. If no `loadType` is specified, the default type `RL` is used.\nPattern: 2 characters\nExample: `\"RL\"`","example":"RL"},"externalAccountId":{"type":"string","nullable":true,"maximum":30,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Identifier supplied by the provider, which is not related to the system. This ID is stored in the system in association with this account and can be provided in the <>s.\nPattern: Max 30 alphanumeric characters. Lowercase only.\nExample: `\"553b45sbs\"`","example":"553b45sbs"},"primaryAccount":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"<> or <> of the primary account to associate this account with. Populate this parameter only when creating a secondary account.\nPattern: PAN or PRN\nExample: `\"123456789012\"`","example":"074103447228"},"sharedBalance":{"type":"integer","format":"int32","enum":[0,1],"nullable":true,"description":"Specifies whether the secondary account will share the balance of the primary account. This parameter is **required** when `primaryAccount` is populated. Do not set this parameter to `1` when `primaryAccount` is not populated.\n* `0` — Do not share the balance\n* `1` — Share the balance\n\nPattern: Integers\nExample: `1`","example":1},"userData":{"type":"string","nullable":true,"maximum":50,"pattern":"^[a-zA-Z0-9 ]*$","description":"Data supplied by the provider, from sources external to the system. This data will be stored in the system in association with this account. The most common use of this parameter is to track affiliate-marketing traffic. The data in this field can be added to an <>.\nPattern: Max 50 alphanumeric characters and spaces\nExample: `\"a4434gg44\"`","example":"a4434gg44"},"verifyOnly":{"type":"integer","format":"int32","enum":[0,1],"nullable":true,"description":"Pass `1` to test the validity of the parameter data without committing the information to the system.\nPattern: Integer\nExample: `1`","example":1},"loadFromAccountNo":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"To load funds into the account at the time of account creation, specify the <> or <> of the source account for the funds. This account must be in the same program as the account being created.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"sweepDate":{"type":"string","format":"date-time","nullable":true,"description":"The last date that a daily sweep should be performed. This parameter is valid only if account sweeping is configured for the product.\nPattern: YYYY-MM-DD\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"creditLimit":{"type":"number","nullable":true,"minimum":0,"description":"Credit limit for card based spending control (currently only available for credit processing).\nPattern: Monetary amount greater than 0.\nExample: `500.25`","example":500.25},"singleUse":{"type":"string","enum":["Y","N"],"nullable":true,"description":"Spending control parameter that flags card for one purchasing transaction (currently only available for credit processing).\nPattern: String\nExample: `\"Y\"`","example":"Y"},"businessName":{"type":"string","nullable":true,"description":"Account holder's business name. This field is **required** if `prodId` is a business product.\nPattern: 2-150 characters. See the supported character set.\nExample: `\"Ed%26Ted\"`","example":"Ed"},"mobilePhoneCountryCode":{"type":"string","nullable":true,"minimum":2,"maximum":4,"pattern":"^\\+[0-9]*$","description":"Account holder's mobile phone country code.\nPattern: A plus sign followed by 1–3 digits. See Phone Validation for valid values. \nExample: `\"+1\"`","example":"+1"}},"required":["prodId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"type":"array","description":"A structure for the response data. It can be empty but usually will contain information.","items":{"type":"object","properties":{"pmt_ref_no":{"type":"string","description":"Payment reference number."},"product_id":{"type":"string","description":"Identifier for the product associated with the account"},"galileo_account_number":{"type":"string","description":"System-generated balance ID"},"card_id":{"type":"string","nullable":true,"description":"System-generated card identifier (CAD). Use this ID instead of the PAN if not PCI-compliant. `None` means that no card was created"},"card_number":{"type":"string","nullable":true,"description":"The primary account number (PAN) printed on the card"},"expiry_date":{"type":"string","nullable":true,"description":"Date when the card expires"},"card_security_code":{"type":"string","nullable":true,"description":"The card verification value (CVV2)"},"cip":{"type":"array","nullable":true,"description":"List of cardholder identification process (CIP) objects","items":{"type":"object","properties":{"status":{"type":"string","description":"Status of the CIP process"},"model_results":{"type":"array","nullable":true,"description":"List of model objects","items":{"type":"object","properties":{"model_name":{"type":"string","nullable":true,"description":"The model name"},"model_version":{"type":"integer","format":"int32","nullable":true,"description":"Version number for the model used"},"code":{"type":"string","nullable":true,"description":"In a model run, lists the pass number"},"text":{"type":"string","nullable":true,"description":"Plain text description of the code value"}},"required":["code","model_name","model_version","text"]}},"date_time":{"type":"string","format":"date-time","description":"The date and time CIP was run"},"first_name":{"type":"string","nullable":true,"description":"Account holder's first name"},"middle_name":{"type":"string","nullable":true,"description":"Account holder's middle name"},"last_name":{"type":"string","nullable":true,"description":"Account holder's last name"},"address_1":{"type":"string","nullable":true,"description":"First line of the account holder's address"},"address_2":{"type":"string","nullable":true,"description":"Second line of the account holder's address"},"city":{"type":"string","nullable":true,"description":"Account holder's city"},"state":{"type":"string","nullable":true,"description":"Account holder's state"},"primary_phone":{"type":"string","nullable":true,"description":"Account holder's primary phone number"},"other_phone":{"type":"string","nullable":true,"description":"Account holder's other phone number"}},"required":["date_time","model_results","status"]}},"billing_cycle_day":{"type":"integer","format":"int32","nullable":true,"description":"The day of the month the billing cycle starts for the account"}},"required":["billing_cycle_day","card_id","card_number","card_security_code","cip","expiry_date","galileo_account_number","pmt_ref_no","product_id"]}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.916,\n \"response_data\": [\n {\n \"pmt_ref_no\": \"001109456010\",\n \"product_id\": \"1665\",\n \"galileo_account_number\": \"462881\",\n \"cip\": [\n {\n \"status\": \"Pass\",\n \"model_results\": [\n {\n \"model_name\": \"BancorpPIDC\",\n \"model_version\": \"3\",\n \"code\": \"Pass A\",\n \"text\": \"Pass A\"\n }\n ],\n \"date_time\": \"2025-07-13 10:37:52\"\n }\n ],\n \"card_id\": \"850238\",\n \"card_number\": \"4870930116312056\",\n \"expiry_date\": \"2025-07-13\",\n \"card_security_code\": \"123\"\n }\n ],\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"RSNU68AN366U7I1UT8JQ\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:37:52\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.717\n \n \n 001109458792\n 1665\n 463167\n \n \n Pass\n \n \n BancorpPIDC\n 3\n Pass A\n Pass A\n \n \n 2025-07-13 12:32:54\n \n \n 850527\n 4870930116314946\n 2025-07-13\n 123\n \n \n \n \n \n UWMMMN71QNNIXE64U4TG\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:32:54\n"}}}},"description":""}},"operationId":"post_createvirtualcard"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/forcePassCip":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Force Pass CIP","description":"Use the Force Pass CIP endpoint to move a customer account into `status: N` and `active: Y`. This endpoint is valid only if you are using the legacy <> method and you verify customer documents when the customer fails CIP. Do not use this endpoint if you are using your own CIP provider or if SoFi Tech Solutions verifies customer documents. This endpoint is not integrated with <>.\n\nConsult the Creating an Account procedure for instructions on using this endpoint.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","type":"object","properties":{}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.46517252922058105,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"6e65bdca-0f44-4380-8aee-38249bdaba43\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 14:05:39\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.04863715171813965\n \n \n \n \n 4b97910c-c89b-41a4-b87c-25bebc5045e4\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 14:05:40\n"}}}},"description":""}},"operationId":"post_forcepasscip"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/createFbEnrollment":{"post":{"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"fbe_status_id":{"type":"string","description":"Federal benefit enrollment ID"}},"required":["fbe_status_id"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"system_timestamp\": \"2025-07-16 11:46:55\",\n \"response_data\": {\n \"fbe_status_id\": \"23443\"\n },\n \"processing_time\": 0.619,\n \"echo\": {\n \"transaction_id\": \"d7947832-9a82-48bf-a75f-a2da5ec6be0f\",\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 2025-07-16 11:46:55\n \n 23443\n \n 0.639\n \n d7947832-9a82-48bf-a75f-a2da5ec6be0f\n \n \n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n"}}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"location":{"type":"string","description":"Unique location identifier; see location types.\nPattern: Must be a number if type is 0; Must be less than 15 characters if type is 1.\nExample: `\"a455-3483\"`","example":"a455-3483"},"locationType":{"type":"integer","format":"int32","enum":[0,1,2],"description":"0=SoFi Tech Solutions location ID\n 1=Partner Location ID\nPattern: `0` or `1`\nExample: `1`","example":1},"recipientType":{"type":"integer","format":"int32","minimum":0,"maximum":9,"description":"Specifies whether the owner of the account in `accountNo` is a direct recipient or a beneficiary:\n* `0` — Direct recipient\n* `1` — Beneficiary\n\nPattern: Integer\nExample: `1`","example":1},"firstName":{"type":"string","minLength":2,"maxLength":30,"description":"Account holder's first name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Ed\"`","example":"Ed"},"lastName":{"type":"string","minLength":2,"maxLength":30,"description":"Account holder's last name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Harley\"`","example":"Harley"},"ssn":{"type":"string","pattern":"^[\\d]{9}$","description":"The Social Security number of the direct recipient of the disbursement.\nPattern: 9-digit Social Security number, no hyphens\nExample: `\"123456789\"`","example":"123456789"},"agencyType":{"type":"string","pattern":"^[A-Z\\/\\s]","description":"One of several defined agency types.\nPattern: See the Federal Benefit Enrollment Agency Types table in Enumerations.\nExample: `\"SOCIAL SECURITY\"`","example":"SOCIAL SECURITY"},"alerts":{"type":"integer","format":"int32","default":0,"enum":[0,1],"nullable":true,"description":"Specifies whether to send alerts regarding the enrollment process.\nPattern: Integer\nExample: `1`","example":1},"agentId":{"type":"integer","format":"int32","nullable":true,"description":"Identifier of the agent, for use in transaction reporting and tracking.\nPattern: Integer\nExample: `109405`","example":109405},"middleName":{"type":"string","nullable":true,"minLength":1,"maxLength":53,"description":"Middle name of the beneficiary.Middle names are not used in ENR transactions, but they are included here for parity between the Account Management and Federal Benefit Enrollment data models. \nPattern: String\nExample: `James`","example":"James"}},"required":["accountNo","agencyType","firstName","lastName","location","locationType","recipientType","ssn","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Federal Benefit Enrollment"],"summary":"Create Federal Benefit Enrollment","parameters":[],"description":"Use the Create Federal Benefit Enrollment endpoint to initiate the process for the specified customer to receive U.S. federal benefit funds via ACH deposit. All enrollments that you initiate with this endpoint are queued into a batch file that is sent regularly (usually daily) to the federal government for processing.\n\n[block:callout]\n\n{\n\"type\": \"info\",\n\"title\": \"Note\",\n\"body\": \"This endpoint automatically creates a secondary account for benefits deposits that shares its balance with the primary account.\"\n}\n[/block]\n\n","operationId":"post_createfbenrollment"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/updateFbEnrollment":{"post":{"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","type":"object","properties":{}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.081,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"V7MEF297XCG81KGWOQN9\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:41:13\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 2025-07-13 10:41:13\n \n 0.081\n \n V7MEF297XCG81KGWOQN9\n \n \n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n"}}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"fbeStatusId":{"type":"integer","format":"int32","minimum":1,"description":"The ID parameter value references the Federal Benefits enrollment to be updated.\nPattern: Integer value as returned by getFbEnrollments().\nExample: `38437`","example":38437},"recipientType":{"type":"integer","format":"int32","nullable":true,"minimum":0,"maximum":9,"description":"Specifies whether the owner of the account in `accountNo` is a direct recipient or a beneficiary:\n* `0` — Direct recipient\n* `1` — Beneficiary\n\nPattern: `0` or `1`\nExample: `1`","example":1},"firstName":{"type":"string","nullable":true,"minimum":1,"maximum":30,"description":"Account holder's first name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Ed\"`","example":"Ed"},"lastName":{"type":"string","nullable":true,"minimum":2,"maximum":30,"description":"Account holder's last name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Harley\"`","example":"Harley"},"ssn":{"type":"string","nullable":true,"pattern":"^[\\d]{9}$","description":"The Social Security number of the direct recipient of the disbursement.\nPattern: 9-digit Social Security number, no hyphens\nExample: `\"123456789\"`","example":"123456789"},"agencyType":{"type":"string","nullable":true,"description":"One of several defined agency types.\nPattern: See the Federal Benefit Enrollment Agency Types table in Enumerations.\nExample: `\"SOCIAL SECURITY\"`","example":"SOCIAL SECURITY"},"status":{"type":"string","nullable":true,"pattern":"[a-zA-z0-9]$","description":"Specifies the state of the federal benefits enrollment. See the Federal Benefit Enrollment Statuses enumeration for valid values.\nPattern: One character\nExample: `\"B\"`","example":"B"},"signedForm":{"type":"string","nullable":true,"minimum":1,"maximum":1,"description":"Specifies whether the form is signed.\nPattern: `Y` or `N`\nExample: `\"Y\"`","example":"Y"},"earlyAccess":{"type":"string","nullable":true,"minimum":1,"maximum":1,"description":"Specifies whether the account is participating in early access.\nPattern: `Y` or `N`\nExample: `\"Y\"`","example":"Y"},"agentId":{"type":"integer","format":"int32","nullable":true,"description":"Identifier of the agent, for use in transaction reporting and tracking.\nPattern: Integer\nExample: `109405`","example":109405},"middleName":{"type":"string","nullable":true,"minLength":1,"maxLength":53,"description":"Middle name of the beneficiary.Middle names are not used in ENR transactions, but they are included here for parity between the Account Management and Federal Benefit Enrollment data models. \nPattern: String\nExample: `James`","example":"James"}},"required":["fbeStatusId","ssn","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Federal Benefit Enrollment"],"summary":"Update Federal Benefit Enrollment","parameters":[],"description":"Use the Update Federal Benefits Enrollment endpoint to modify an existing federal benefits enrollment prior to re-submitting it with the Resubmit Federal Benefit Enrollment endpoint.","operationId":"post_updatefbenrollment"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getFbEnrollments":{"post":{"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"found":{"type":"integer","format":"int32","description":"The number of federal benefit enrollments found for the account"},"results":{"type":"array","description":"A list if enrollment objects","items":{"description":"A data structure that contains enrollment information fields","type":"object","properties":{"fbe_status_id":{"type":"string","description":"Federal benefit enrollment ID"},"pmt_ref_no":{"type":"string","description":"Payment reference number."},"fbe_dda":{"type":"string","description":"PRN for the federal benefit enrollment <>"},"status":{"type":"string","description":"The status of the enrollment. See Federal Benefit Enrollment Statuses."},"enrolled_date":{"type":"string","format":"date","description":"Date when the federal benefit enrollment record was created"},"submitted_date":{"type":"string","format":"date","description":"Date when the federal benefit enrollment record was last submitted"},"noted_date":{"type":"string","format":"date","nullable":true,"description":"Shows either the date of the last deposit or the last confirmed date"},"product_description":{"type":"string","nullable":true,"description":"Description of the product"},"card_status":{"type":"string","nullable":true,"description":"The status of the card"},"beneficiary_ssn":{"type":"string","nullable":true,"description":"The SSN of the beneficiary"},"beneficiary_first_name":{"type":"string","nullable":true,"description":"The first name of the beneficiary"},"beneficiary_last_name":{"type":"string","nullable":true,"description":"The last name of the beneficiary"},"original_pmt_ref_no":{"type":"string","nullable":true,"description":"PRN for the input account associated with the federal benefit <>"},"status_description":{"type":"string","nullable":true,"description":"A description of the status"},"benefit_type":{"type":"string","nullable":true,"description":"The federal benefit enrollment agency type"},"recipient_type":{"type":"string","nullable":true,"description":"Description of the federal benefit enrollment agency type specified in the `benefit_type` field"},"beneficiary_middle_name":{"type":"string","nullable":true,"description":"Middle name of the beneficiary.Middle names are not used in ENR transactions,but they are included here for parity between the Account Management and Federal Benefit Enrollment data models. \nPattern: String\nExample: `James`"},"enr_returned_date":{"type":"string","format":"date","nullable":true,"description":"Date when the federal benefit enrollment record was returned"},"enr_return_code":{"type":"string","nullable":true,"description":"Return code the federal benefit enrollment was returned with","example":"R47"}},"required":["beneficiary_first_name","beneficiary_last_name","beneficiary_ssn","benefit_type","card_status","enrolled_date","fbe_dda","fbe_status_id","noted_date","pmt_ref_no","recipient_type","status","status_description","submitted_date"]}}},"required":["found","results"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.578,\n \"response_data\": {\n \"found\": 2,\n \"results\": [\n {\n \"fbe_status_id\": 78,\n \"pmt_ref_no\": \"412101012877\",\n \"fbe_dda\": \"412101012877\",\n \"status\": \"U\",\n \"enrolled_date\": \"2025-04-20\",\n \"submitted_date\": null,\n \"noted_date\": null,\n \"product_description\": \"NexsCard Personalized (MCB)\",\n \"card_status\": \"X\",\n \"beneficiary_ssn\": \"526464928\",\n \"beneficiary_first_name\": \"Ruisiwwk\",\n \"beneficiary_last_name\": \"Qnesgzfd\",\n \"original_pmt_ref_no\": \"412101006366\",\n \"status_description\": \"Updated\",\n \"benefit_type\": \"Social Security\",\n \"recipient_type\": \"Card Holder\"\n },\n {\n \"fbe_status_id\": 79,\n \"pmt_ref_no\": \"412101012885\",\n \"fbe_dda\": \"412101012885\",\n \"status\": \"E\",\n \"enrolled_date\": \"2025-04-20\",\n \"submitted_date\": null,\n \"noted_date\": null,\n \"product_description\": \"NexsCard Personalized (MCB)\",\n \"card_status\": \"X\",\n \"beneficiary_ssn\": \"535732299\",\n \"beneficiary_first_name\": \"Ageqxjel\",\n \"beneficiary_last_name\": \"Ccmragoy\",\n \"original_pmt_ref_no\": \"412101006366\",\n \"status_description\": \"Entered\",\n \"benefit_type\": \"Social Security\",\n \"recipient_type\": \"Card Holder\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"DK86NSC5ZCH4W3RA7ESS\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:45:21\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 1.671\n \n 2\n \n \n 78\n 412101012877\n 412101012877\n U\n 2025-04-20\n \n \n NexsCard Personalized (MCB)\n X\n 526464928\n Fvpvefcl\n Gzwywlrl\n 412101006366\n Updated\n Social Security\n Card Holder\n \n \n 79\n 412101012885\n 412101012885\n E\n 2025-04-20\n \n \n NexsCard Personalized (MCB)\n X\n 535732299\n Ageqxjel\n Ccmragoy\n 412101006366\n Entered\n Social Security\n Card Holder\n \n \n \n \n \n \n 3XC10I66K3KL67PRZDVG\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:38:54\n"}}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PRN or PAN\nExample: `\"074103447228\"`","example":"074103447228"},"fbeDda":{"type":"string","nullable":true,"minLength":1,"maxLength":19,"pattern":"^[0-9]+$","description":"The PRN of the federal benefits enrollment <>.\nPattern: PRN\nExample: `\"074103447228\"`","example":"074103447228"},"agencyType":{"type":"string","nullable":true,"description":"The type of agency that is providing the benefit. See the Federal Benefit Enrollment Agency Types enumeration for valid values.\nPattern: String\nExample: `\"SOCIAL SECURITY\"`","example":"SOCIAL SECURITY"},"status":{"type":"string","nullable":true,"description":"Specifies the state of the federal benefits enrollment. See the Federal Benefit Enrollment Statuses enumeration for valid values.\nPattern: One character\nExample: `\"B\"`","example":"B"},"beneficiarySsn":{"type":"string","nullable":true,"maxLength":12,"description":"The Social Security number of the beneficiary of the disbursement.\nPattern: 9-digit Social Security number, no hyphens\nExample: `\"123456789\"`","example":"123456789"},"beneficiaryFirstName":{"type":"string","nullable":true,"description":"Account holder's first name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Ed\"`","example":"Ed"},"beneficiaryLastName":{"type":"string","nullable":true,"description":"Cardholder's last name\nAccount holder's last name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Harley\"`","example":"Harley"},"enrolledFrom":{"type":"string","nullable":true,"maxLength":11,"pattern":"[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])","description":"Date enrollment started.\nPattern: YYYY-MM-DD\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"enrolledTo":{"type":"string","nullable":true,"maxLength":11,"pattern":"[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])","description":"Date enrolled to.\nPattern: YYYY-MM-DD\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"submittedFrom":{"type":"string","nullable":true,"maxLength":11,"pattern":"[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])","description":"Date submitted from.\nPattern: YYYY-MM-DD\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"submittedTo":{"type":"string","nullable":true,"maxLength":11,"pattern":"[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])","description":"Date submitted to.\nPattern: YYYY-MM-DD\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"notedFrom":{"type":"string","nullable":true,"maxLength":11,"pattern":"[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])","description":"Date noted from.\nPattern: YYYY-MM-DD\nExample: `\"2016-01-01\"`"},"notedTo":{"type":"string","nullable":true,"maxLength":11,"pattern":"[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])","description":"Date noted to.\nPattern: YYYY-MM-DD\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"enrReturnedFrom":{"type":"string","nullable":true,"maxLength":11,"pattern":"[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])","description":"Date enr_returned from.\nPattern: YYYY-MM-DD\nExample: `\"2016-01-01\"`"},"enrReturnedTo":{"type":"string","nullable":true,"maxLength":11,"pattern":"[0-9]{4}-(1[0-2]|0[1-9])-(0[1-9]|[1-2][0-9]|3[0-2])","description":"Date enr_returned to.\nPattern: YYYY-MM-DD\nExample: `\"2016-01-01\"`","example":"2016-01-01"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Federal Benefit Enrollment"],"summary":"Get Federal Benefit Enrollments","parameters":[],"description":"Use the Get Federal Benefit Enrollments endpoint to retrieve information on the federal benefit enrollments of the specified account.","operationId":"post_getfbenrollments"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/resubmitFbEnrollment":{"post":{"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","type":"object","properties":{}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.744,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"XZYA1XPQHFL6XLAF8WKW\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:45:25\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.114\n \n \n \n \n TR42GAPFK8DQQN2I6NJ8\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:38:55\n"}}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"fbeStatusId":{"type":"integer","format":"int32","minimum":1,"description":"The federal benefits enrollment ID (`fbe_status_id`) as returned by the Create Federal Benefit Enrollment endpoint.\nPattern: Integer\nExample: `1`","example":1},"recipientType":{"type":"integer","format":"int32","minimum":0,"maximum":9,"description":"Specifies whether the owner of the account in `accountNo` is a direct recipient or a beneficiary:\n* `0` — Direct recipient\n* `1` — Beneficiary\n\nPattern: `0` or `1`\nExample: `1`","example":0},"firstName":{"type":"string","minimum":1,"maximum":30,"description":"Account holder's first name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Ed\"`","example":"Ed"},"lastName":{"type":"string","minimum":2,"maximum":30,"description":"Account holder's last name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Harley\"`","example":"Harley"},"ssn":{"type":"string","pattern":"^[\\d]{9}$","description":"The Social Security number of the direct recipient of the disbursement.\nPattern: 9-digit Social Security number, no hyphens\nExample: `\"123456789\"`","example":"123456789"},"agencyType":{"type":"string","description":"One of several defined agency types.\nPattern: See the Federal Benefit Enrollment Agency Types table in Enumerations.\nExample: `\"SOCIAL SECURITY\"`","example":"SOCIAL SECURITY"},"agentId":{"type":"integer","format":"int32","nullable":true,"description":"Identifier of the agent, for use in transaction reporting and tracking.\nPattern: Integer\nExample: `109405`","example":109405},"middleName":{"type":"string","nullable":true,"minLength":1,"maxLength":53,"description":"Middle name of the beneficiary.Middle names are not used in ENR transactions,but they are included here for parity between the Account Management and Federal Benefit Enrollment data models. \nPattern: String\nExample: `James`","example":"James"}},"required":["agencyType","fbeStatusId","firstName","lastName","recipientType","ssn","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Federal Benefit Enrollment"],"summary":"Resubmit Federal Benefit Enrollment","parameters":[],"description":"Use the Resubmit Federal Benefit Enrollment endpoint to submit an amended federal-benefit enrollment record and send it in for processing. You can modify the name and SSN parameters as part of resubmittal.","operationId":"post_resubmitfbenrollment"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/voidCreateAccount":{"post":{"tags":["Instant Issue"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PRN or PAN\nExample: `\"074103447228\"`","example":"074103447228"},"type":{"type":"string","enum":["1","2",1,2],"description":"Type of void being performed:\n* `\"1\"` — Cancel account\n* `\"2\"` — Reset account (for instant issue)\n\nPattern: String\nExample: `\"1\"`","example":"1"},"verifyOnly":{"type":"boolean","default":false,"description":"Pass `1` to test the validity of the parameter data without committing the information to the system.\nPattern: Integer\nExample: `0`","example":"0"}},"required":["transactionId","type","apiLogin","apiTransKey","providerId"]}}}},"summary":"Void Create Account","description":"Use the Void Create Account endpoint to cancel an account (move the account into `status: B`, Voided account) that was created by Create Account. Pass either the `transactionId` of the original Create Account call or the optional `accountNo` parameter to identify and void the created account. The `accountNo` parameter can be the PRN that was returned by Create Account or a PAN that you can retrieve using Get Account Cards.\n\n> 📘 Note\n> \n> Use Void Create Account only for instant-issue (prepaid) card accounts. To reverse an account creation for other account types, use the <>.\n\n","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","type":"object","properties":{}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.0078,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"OOSQCGXU0NUE6AIPQ3OA\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:42:56\"\n}\n"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 2011-01-31 13:37:18\n \n 1.755\n \n 12345a\n 77bb\n 2025-02-06 10:10:10\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n"}}}},"description":""}},"operationId":"post_voidcreateaccount"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getAccountFeatures":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Get Account Features","description":"Use the Get Account Features endpoint to retrieve the account features that are set for the specified customer account.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"features":{"type":"array","description":"List of feature objects","items":{"description":"A data structure that contains information about one or more features.","type":"object","properties":{"type":{"type":"integer","format":"int32","description":"Identifier for the feature type"},"name":{"type":"string","nullable":true,"description":"Description of the feature type specified in the `type` field"},"value":{"type":"string","nullable":true,"description":"A value associated with the feature type specified in the `type` field"},"start_date":{"type":"string","format":"date","nullable":true,"description":"The feature start date"},"end_date":{"type":"string","format":"date","nullable":true,"description":"The feature end date"}},"required":["end_date","name","start_date","type","value"]}}},"required":["features"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.057,\n \"response_data\": {\n \"features\": [\n {\n \"type\": 3,\n \"name\": \"Product ID\",\n \"value\": \"88\",\n \"start_date\": null,\n \"end_date\": null\n },\n {\n \"type\": 5,\n \"name\": \"Express mail\",\n \"value\": \"N\",\n \"start_date\": null,\n \"end_date\": null\n },\n {\n \"type\": 6,\n \"name\": \"Allow card not present transactions\",\n \"value\": \"Y\",\n \"start_date\": \"2025-04-04\",\n \"end_date\": \"3000-01-01\"\n },\n {\n \"type\": 8,\n \"name\": \"Allow international transactions\",\n \"value\": \"Y\",\n \"start_date\": \"2025-07-13\",\n \"end_date\": \"3000-01-01\"\n },\n {\n \"type\": 14,\n \"name\": \"Disable Dynamic Fraud Rules\",\n \"value\": \"N\",\n \"start_date\": \"2025-04-04\",\n \"end_date\": \"2025-04-04\"\n },\n {\n \"type\": 20,\n \"name\": \"Token Transactions Only\",\n \"value\": \"N\",\n \"start_date\": \"2025-07-13\",\n \"end_date\": \"3000-01-01\"\n },\n {\n \"type\": 21,\n \"name\": \"Token Transactions when Card Present Only\",\n \"value\": \"N\",\n \"start_date\": \"2025-07-13\",\n \"end_date\": \"3000-01-01\"\n },\n {\n \"type\": 22,\n \"name\": \"Block Token Transactions\",\n \"value\": \"N\",\n \"start_date\": \"2025-07-13\",\n \"end_date\": \"3000-01-01\"\n },\n {\n \"type\": 23,\n \"name\": \"First Delinquent Date\",\n \"value\": \"07132020\",\n \"start_date\": \"2025-07-13\",\n \"end_date\": \"3000-01-01\"\n },\n {\n \"type\": 24,\n \"name\": \"Delinquency Amount\",\n \"value\": \"187.63\",\n \"start_date\": \"2025-07-13\",\n \"end_date\": \"3000-01-01\"\n },\n {\n \"type\": 25,\n \"name\": \"Emboss line 2\",\n \"value\": \"Emboss Line 2\",\n \"start_date\": \"2025-07-13\",\n \"end_date\": \"3000-01-01\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"JSGZR1UJVV87KCTX0XVD\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:39:08\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.075\n \n \n \n 3\n Product ID\n 88\n \n \n \n \n 5\n Express mail\n N\n \n \n \n \n 6\n Allow card not present transactions\n Y\n 2025-04-04\n 3000-01-01\n \n \n 8\n Allow international transactions\n Y\n 2025-07-13\n 3000-01-01\n \n \n 14\n Disable Dynamic Fraud Rules\n N\n 2025-04-04\n 2025-04-04\n \n \n 20\n Token Transactions Only\n N\n 2025-07-13\n 3000-01-01\n \n \n 21\n Token Transactions when Card Present Only\n N\n 2025-07-13\n 3000-01-01\n \n \n 22\n Block Token Transactions\n N\n 2025-07-13\n 3000-01-01\n \n \n 23\n First Delinquent Date\n 07132020\n 2025-07-13\n 3000-01-01\n \n \n 24\n Delinquency Amount\n 187.63\n 2025-07-13\n 3000-01-01\n \n \n 25\n Emboss line 2\n Emboss Line 2\n 2025-07-13\n 3000-01-01\n \n \n \n \n \n \n 4TLV2QP7VWLSOLW9JRIY\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:32:31\n"}}}},"description":""}},"operationId":"post_getaccountfeatures"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/setAccountFeature":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <>, <> or <> of the account.\nPattern: PAN, PRN, or CAD\nExample: `\"074103447228\"`","example":"074103447228"},"featureType":{"type":"integer","format":"int32","minimum":0,"maximum":999,"description":"Consult the **featureType** column in the Set Account Feature Values table for valid values.\nPattern: Integer\nExample: `3`","example":3},"featureValue":{"type":"string","nullable":true,"pattern":"^[\\w\\W\\s\\d\\|_\\. '`\\?,!@\\$%#\\\"\\/\\-=~]{1,255}$","description":"Consult the **featureValue** column in the Set Account Feature Values table for valid values.\nPattern: As specified in the **featureValue** column\nExample: `Y`","example":"Y"},"startDate":{"type":"string","format":"date-time","nullable":true,"description":"The starting date-time for the date range. Default: current date-time\nPattern: YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01 10:10:15\"`","example":"2016-01-01 10:10:15"},"endDate":{"type":"string","format":"date-time","nullable":true,"description":"The ending date-time for the date range; must be equal to or later than `startDate`. Default: 3000-01-01 00:01:00\nPattern: YYYY-MM-DD hh:mm:ss\nExample: `\"2016-02-01 10:10:10\"`","example":"2016-02-01 10:10:10"}},"required":["accountNo","featureType","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Set Account Feature","description":"Use the Set Account Feature endpoint to set or modify specified attributes of a customer account.\n* When enabling and disabling fraud rules (`featureType: 14`), keep in mind that if you pass `featureValue: Y` and do not pass `endDate`, the end date is set to 3000-01-01, meaning that fraud rules are suspended indefinitely. To update the timespan for fraud-rule suspension, pass `featureValue: Y` and the new start and/or end date-times. To immediately re-enable fraud rules, pass `featureValue: N`. When `featureValue: N`, the date fields are ignored.\n* When you change account features 20, 21 or 22, you can arrange with SoFi Tech Solutions to receive the `ACFC: account_feature_change` event message.\n[block:callout]\n{\n\"type\": \"info\",\n\"title\": \"Note\",\n\"body\": \"Feature types 20, 21, and 22 are mutually exclusive. Only one can be set to `Y` at a time.\"\n}\n[/block]\n\n","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"feature_value":{"type":"string","nullable":true,"description":"The feature value"}},"required":["feature_value"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.043,\n \"response_data\": {\n \"feature_value\": \"Y\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"S1H4BG1KOP470WR1IK8R\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:39:39\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.056\n \n Y\n \n \n \n \n J6ZXPPR97TW4JP9Z9M5U\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:33:01\n"}}}},"description":""}},"operationId":"post_setaccountfeature"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/verifyAccount":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PRN or PAN\nExample: `\"074103447228\"`","example":"074103447228"},"loadType":{"type":"string","nullable":true,"pattern":"^[a-zA-Z0-9]{1,2}$","description":"Load type (otype) of the load to verify. Use values from your list of load types from SoFi Tech Solutions. If no `loadType` is specified, the default type `RL` is used.\nPattern: 2 alphanumeric characters\nExample: `\"RL\"`","example":"RL"},"includeRelated":{"type":"integer","format":"int32","default":0,"enum":[0,1],"description":"Whether to return data for all accounts that share the same account holder (`client_id`).\n- `0` or _blank_ — **Default**. Retrieve only the specified account.\n- `1` — Retrieve all accounts from the same account holder`.\n\nPattern: Integer\nExample: `1`","example":1}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Verify Account","description":"Use the Verify Account endpoint to return information on an account. For example, you can use this endpoint to validate that you can call Create Payment on the account without violating the load amount. Verify Account will also return secondary accounts that share the same balance ID and product ID.\n\nThis endpoint returns:\n* Current account balance — Both posted and authorized transactions are factored into the balance amount\n* Current maximum amount that can be loaded into the account, according to product parameters\n* External account ID\n* Account PRN\n* Galileo account number (balance ID)\n","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"accounts":{"type":"array","description":"List of account objects","items":{"type":"object","properties":{"max_load_amount":{"type":"string","description":"The maximum amount that can be loaded on a credit card"},"balance":{"type":"number","format":"float","description":"The amount of money in a savings or checking account"},"external_account_id":{"type":"string","nullable":true,"description":"An external account ID provided by the client"},"pmt_ref_no":{"type":"string","description":"A system-generated account number"},"account_status":{"type":"string","description":"The condition of the account after a modification"},"galileo_account_number":{"type":"string","description":"System-generated integer account number, also known as balance ID"},"product_id":{"type":"string","description":"System-generated integer"}},"required":["account_status","balance","external_account_id","galileo_account_number","max_load_amount","pmt_ref_no","product_id"]}}},"required":["accounts"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.097,\n \"response_data\": {\n \"accounts\": [\n {\n \"account_status\": \"V\",\n \"balance\": 10,\n \"external_account_id\": null,\n \"galileo_account_number\": \"462956\",\n \"max_load_amount\": \"2490\",\n \"pmt_ref_no\": \"001109456770\",\n \"product_id\": \"88\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"0HH0MOFZYV79GYXZ1Z1E\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:40:07\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.108\n \n \n \n N\n 1224.7\n \n 386957\n 2380\n 001104890593\n 88\n \n \n \n \n \n \n R6WCQILG86LC078PD3YH\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:33:21\n"}}}},"description":""}},"operationId":"post_verifyaccount"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getCustomerNoteHistory":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"startDate":{"type":"string","format":"date","description":"The beginning date for the date range, either a date or a date-time.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"endDate":{"type":"string","format":"date","description":"The end date for the date range, either a date or a date-time. Must be equal to or later than `startDate`.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"}},"required":["accountNo","endDate","startDate","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Get Customer Note History","description":"Use the Get Customer Note History endpoint to retrieve the customer notes that are in the <>. This endpoint requires a date range: 365 days maximum.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"notes":{"type":"array","description":"List of note objects","items":{"description":"A data structure that contains information on one or more notes","type":"object","properties":{"date":{"type":"string","format":"date-time","description":"The date and time the associated note entered the system"},"note_id":{"type":"string","description":"An ID number that identifies a customer note"},"agent":{"type":"string","description":"Identifies a person or automated software source"},"note":{"type":"string","description":"A data structure that displays a note and/or note information"},"sticky":{"type":"string","description":"A code that indicates if the note is permanent or not"}},"required":["agent","date","note","note_id","sticky"]}}},"required":["notes"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.069,\n \"response_data\": {\n \"notes\": [\n {\n \"date\": \"2025-11-18 15:12:36\",\n \"note_id\": \"16477\",\n \"agent\": \"jjones\",\n \"note\": \"Password changed for customer.\",\n \"sticky\": \"0\"\n },\n {\n \"date\": \"2025-11-18 15:12:36\",\n \"note_id\": \"16476\",\n \"agent\": \"jjones\",\n \"note\": \"Customer profile updated. Email changed to bob@bob.com.\",\n \"sticky\": \"0\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"O63HGOAZ87D79UB6DIR5\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:39:09\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.05\n \n \n \n 2025-11-18 15:12:36\n 16477\n jjones\n Password changed for customer.\n 0\n \n \n 2025-11-18 15:12:36\n 16476\n jjones\n Customer profile updated. Email changed to bob@bob.com.\n 0\n \n \n \n \n \n \n HFTDAH873ZM6NLY8537W\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:32:32\n"}}}},"description":""}},"operationId":"post_getcustomernotehistory"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/addCustomerNote":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"note":{"type":"string","minimum":1,"maximum":2000,"description":"Text of the note.\nPattern: Alphanumeric string including punctuation\nExample: `\"Sample note message here.\"`","example":"Sample note message here."},"sticky":{"type":"string","nullable":true,"pattern":"^(1|0)$","description":"Pass `1` to make the note permanent in the <>.\nPattern: `0` or `1`\nExample: `\"1\"`","example":"1"},"userId":{"type":"string","nullable":true,"description":"Email address of the agent adding the note.\nPattern: Email address\nExample: `\"user123@example.com\"`","example":"user123@example.com"}},"required":["accountNo","note","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Add Customer Note","description":"Use the Add Customer Note endpoint to create a note that is accessible in the <>.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"note_id":{"type":"string","description":"An ID number that identifies a customer note."}},"required":["note_id"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.054,\n \"response_data\": {\n \"note_id\": \"44307\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"RY8GFEVXEYY2DVEIE275\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:38:56\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.036\n \n 44331\n \n \n \n \n 5MIXM8LXMV3JT7CQDSQ3\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:32:21\n"}}}},"description":""}},"operationId":"post_addcustomernote"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/setUserDefinedAccountField":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"fieldId":{"type":"string","pattern":"^[a-zA-Z0-9]{1,15}$","description":"Field identifier or key name.\nPattern: 1–15 alphanumeric characters\nExample: `\"MYACCTID\"`","example":"MYACCTID"},"fieldValue":{"type":"string","minLength":1,"maxLength":175,"description":"Field value.\nPattern: 1–175 characters\nExample: `\"48547537447-ABCD\"`","example":"48547537447-ABCD"}},"required":["accountNo","fieldId","fieldValue","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Set User-Defined Account Field","description":"Use the Set User-Defined Account Field endpoint to create or update custom data elements on an account. There is no technical limit on the number of fields that you can add. See User-defined account fields in _About Accounts_ for more information.\n\n- `fieldId` — Provide an identifier for the field. This identifier must be unique only to the account.\n- `fieldValue` — Provide the value for that field.\n\nThese fields are visible in the <> on the account's landing page.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"field_id":{"type":"string","description":"A field identifier or key name"},"field_value":{"type":"string","description":"A value placed into the created field"},"last_modified":{"type":"string","format":"date-time","description":"A time and date stamp that shows the last time the custom field was modified"}},"required":["field_id","field_value","last_modified"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.054,\n \"response_data\": {\n \"field_id\": \"MYACCTID\",\n \"field_value\": \"HVFQSWMD\",\n \"last_modified\": \"2025-07-13 10:39:51\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"0KLB61EGAX0G6CSRD6QJ\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:39:51\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 2025-07-13 10:39:51\n \n MYACCTID\n HVFQSWMD\n 2025-07-13 10:39:51\n \n 0.054\n \n 0KLB61EGAX0G6CSRD6QJ\n \n \n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n"}}}},"description":""}},"operationId":"post_setuserdefinedaccountfield"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getUserDefinedAccountFields":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Get User-Defined Account Fields","description":"Use the Get User-Defined Account Fields endpoint to retrieve the user-defined fields and values that were created with the Set User-Defined Account Field endpoint. See User-defined account fields in _About Accounts_ for more information.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"accounts":{"type":"array","description":"List of account objects","items":{"type":"object","properties":{"pmt_ref_no":{"type":"string","description":"A system-generated account number"},"user_defined_fields":{"type":"array","items":{"description":"A data structure that displays one or more user defined fields","type":"object","properties":{"field_id":{"type":"string","description":"A field ID"},"field_value":{"type":"string","description":"A value placed into the created field"},"last_modified":{"type":"string","format":"date-time","description":"A time and date stamp that shows the last time the custom field was modified"}},"required":["field_id","field_value","last_modified"]}}},"required":["pmt_ref_no","user_defined_fields"]}}},"required":["accounts"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.127,\n \"response_data\": {\n \"accounts\": [\n {\n \"pmt_ref_no\": \"001104890593\",\n \"user_defined_fields\": [\n {\n \"field_id\": \"MYACCTID\",\n \"field_value\": \"xbftpjeu\",\n \"last_modified\": \"2025-10-08 15:23:20.000\"\n }\n ]\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"Y9NEHUZT7KY0NK0SAURI\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:39:11\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.105\n \n \n \n 001104890593\n \n \n MYACCTID\n xbftpjeu\n 2025-10-08 15:23:20.000\n \n \n \n \n \n \n \n \n 3AA0D888UT7U5X8OI60X\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:32:34\n"}}}},"description":""}},"operationId":"post_getuserdefinedaccountfields"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getAccountById":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"id":{"type":"string","nullable":true,"description":"Unique identifier for an account holder. This is the primary `id` that was passed in an enrollment endpoint request during account creation. The system converts all letters to lowercase.\nPattern: See Customer ID Types\nExample: `\"123456789\"`","example":"123456789"},"idType":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18],"nullable":true,"description":"Specifies the type of primary identifier in the `id` parameter. This parameter is **required** when `id` is populated. See the **ID** column in the Customer ID Types table for valid values.\nPattern: 1- or 2-digit integer\nExample: `2`","example":2},"externalCustomerId":{"type":"string","nullable":true,"maximum":512,"description":"User-supplied identifier that is related to an external system.\nPattern: Max 512 characters: all ASCII characters\nExample: `\"acv#-@45!sbsxm%-\"`","example":"acv#-@45!sbsxm%-"},"customerId":{"type":"integer","format":"int32","nullable":true,"minimum":1,"description":"Galileo's internal, unique customer identifier, called `client_id` in the code. This is a deterministic 1:1 lookup key for a single customer. When provided, the response includes the customer's `externalCustomerId`.\nPattern: Positive integer\nExample: `123456789`","example":123456789}},"required":["transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Get Account by ID","description":"Use the Get Account by ID endpoint to retrieve account information using _exactly one_ of the mutually exclusive lookup keys. See Account lookup for specific instructions.\n\nThis endpoint returns customer data such as enrollment status and onboarding date as well as a list of all accounts associated with the customer. Each account entry includes `closureDate` to indicate when the account was closed. `closureDate` is populated only when the account is in status `C` (closed/canceled), `Z` (closed/canceled without refund), or `R` (charged off); it is `null` for open accounts.\n\nTo search on broader criteria, try Search Accounts.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"accounts":{"type":"array","description":"List of accounts","items":{"description":"Acts as a logical separator between accounts if more than one is returned","type":"object","properties":{"prn":{"type":"string","description":"The payment reference number"},"prod_id":{"type":"string","description":"A unique product identifier from SoFi Tech Solutions"},"app_date":{"type":"string","format":"date-time","nullable":true,"description":"The date the account's application was submitted"},"status":{"type":"string","description":"The status of the account"},"active_flag":{"type":"string","description":"Whether the account is active"},"balance":{"type":"number","format":"float","nullable":true,"description":"The available balance of the account"},"closure_date":{"type":"string","format":"date-time","nullable":true,"description":"UTC timestamp (`YYYY-MM-DD hh:mm:ss`) of when the account was closed. Populated only when status is `C` (closed/canceled), `Z` (closed/canceled without refund), or `R` (charged off); `null` means the account is open."},"galileo_account_number":{"type":"string","nullable":true,"description":"The balance ID of the account."},"cards":{"type":"array","nullable":true,"description":"List of the cards associated with the account","items":{"type":"object","properties":{"card_id":{"type":"string","description":"The card identifier (CAD)"},"card_status":{"type":"string","description":"The status of the card"}},"required":["card_id","card_status"]}}},"required":["active_flag","app_date","galileo_account_number","prn","prod_id","status"]}},"externalCustomerId":{"type":"string","nullable":true,"description":"The customer's `externalCustomerId`. Returned only when the lookup resolves to a single customer, as when the request is made with `customerId`. Omitted for lookups that may span multiple customers."}},"required":["accounts"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.24,\n \"response_data\": {\n \"accounts\": [\n {\n \"prn\": \"001109456341\",\n \"prod_id\": \"88\",\n \"app_date\": \"2025-07-13 10:38:57\",\n \"status\": \"V\",\n \"active_flag\": \"N\",\n \"balance\": 10,\n \"closure_date\": null,\n \"galileo_account_number\": \"462956\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"HKHFA2P57UHZH2I7HIIW\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:38:58\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.147\n \n \n \n 001104898505\n 88\n 2025-05-16\n N\n Y\n 65.05\n 462956\n \n \n \n \n \n \n 7R19V6ENCH5VMTN8CE98\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:32:23\n"}}}},"description":""}},"operationId":"post_getaccountbyid"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getRelatedAccounts":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Get Related Accounts","description":"Use the Get Related Accounts endpoint to retrieve all accounts that are related to the account specified in `accountNo`. This endpoint returns all accounts with the same owner. If a secondary account is passed, it returns the primary account and other secondaries associated with the same primary.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"self_accounts":{"type":"array","description":"Accounts that belong to the same customer.","items":{"type":"object","properties":{"prn":{"type":"string","description":"The payment reference number of the account."},"product_id":{"type":"string","description":"The identifier for the product that this account belongs to."},"galileo_account_number":{"type":"string","nullable":true,"description":"The balance ID of the account."},"status":{"type":"string","description":"The status of the account. See Account Statuses for valid values."},"active":{"type":"string","description":"Whether the account is active: `Y` or `N`"}},"required":["active","galileo_account_number","prn","product_id","status"]}},"child_accounts":{"type":"array","description":"Accounts that are secondary accounts to the primary account in `accountNo`.","items":{"type":"object","properties":{"prn":{"type":"string","description":"The payment reference number of the account."},"product_id":{"type":"string","description":"The identifier for the product that this account belongs to."},"galileo_account_number":{"type":"string","nullable":true,"description":"The balance ID of the account."},"status":{"type":"string","description":"The status of the account. See Account Statuses for valid values."},"active":{"type":"string","description":"Whether the account is active: `Y` or `N`"}},"required":["active","galileo_account_number","prn","product_id","status"]}},"parent_accounts":{"type":"array","description":"If `accountNo` contains a secondary account, this is the primary account that it is associated with.","items":{"type":"object","properties":{"prn":{"type":"string","description":"The payment reference number of the account."},"product_id":{"type":"string","description":"The identifier for the product that this account belongs to."},"galileo_account_number":{"type":"string","nullable":true,"description":"The balance ID of the account."},"status":{"type":"string","description":"The status of the account. See Account Statuses for valid values."},"active":{"type":"string","description":"Whether the account is active: `Y` or `N`"}},"required":["active","galileo_account_number","prn","product_id","status"]}},"sibling_accounts":{"type":"array","description":"If `accountNo` contains a secondary account, these are other secondary accounts that are associated with the primary account in `parent_accounts`.","items":{"type":"object","properties":{"prn":{"type":"string","description":"The payment reference number of the account."},"product_id":{"type":"string","description":"The identifier for the product that this account belongs to."},"galileo_account_number":{"type":"string","nullable":true,"description":"The balance ID of the account."},"status":{"type":"string","description":"The status of the account. See Account Statuses for valid values."},"active":{"type":"string","description":"Whether the account is active: `Y` or `N`"}},"required":["active","galileo_account_number","prn","product_id","status"]}}},"required":["child_accounts","parent_accounts","self_accounts","sibling_accounts"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.074,\n \"response_data\": {\n \"parent_accounts\": [\n {\n \"active\": \"Y\",\n \"status\": \"N\",\n \"galileo_account_number\": \"5013429\",\n \"prn\": \"005462577202\",\n \"product_id\": \"12827\"\n },\n {\n \"active\": \"Y\",\n \"status\": \"N\",\n \"galileo_account_number\": \"5013430\",\n \"prn\": \"005462578202\",\n \"product_id\": \"12827\"\n }\n ],\n \"sibling_accounts\": [\n {\n \"active\": \"Y\",\n \"status\": \"N\",\n \"galileo_account_number\": \"5013431\",\n \"prn\": \"005462579202\",\n \"product_id\": \"12827\"\n },\n {\n \"active\": \"Y\",\n \"status\": \"N\",\n \"galileo_account_number\": \"5013432\",\n \"prn\": \"005462580202\",\n \"product_id\": \"12827\"\n }\n ],\n \"child_accounts\": [\n {\n \"active\": \"Y\",\n \"status\": \"N\",\n \"galileo_account_number\": \"5013427\",\n \"prn\": \"005462575202\",\n \"product_id\": \"12827\"\n },\n {\n \"active\": \"Y\",\n \"status\": \"N\",\n \"galileo_account_number\": \"5013428\",\n \"prn\": \"005462576202\",\n \"product_id\": \"12827\"\n }\n ],\n \"self_accounts\": [\n {\n \"active\": \"Y\",\n \"status\": \"N\",\n \"galileo_account_number\": \"5013424\",\n \"prn\": \"005462572202\",\n \"product_id\": \"12827\"\n },\n {\n \"active\": \"Y\",\n \"status\": \"N\",\n \"galileo_account_number\": \"5013425\",\n \"prn\": \"005462573202\",\n \"product_id\": \"12827\"\n },\n {\n \"active\": \"Y\",\n \"status\": \"N\",\n \"galileo_account_number\": \"5013426\",\n \"prn\": \"005462574202\",\n \"product_id\": \"12827\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"82KE6A1RUQ5HPX69TY4L\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:31:56\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.076\n \n \n\t\t- \n\t\t\tY\n\t\t\tN\n\t\t\t5013429\n\t\t\t005462577202\n\t\t\t12827\n\t\t
\n\t\t- \n\t\t\tY\n\t\t\tN\n\t\t\t5013430\n\t\t\t005462578202\n\t\t\t12827\n\t\t
\n\t\n\t\n\t\t- \n\t\t\tY\n\t\t\tN\n\t\t\t5013431\n\t\t\t005462579202\n\t\t\t12827\n\t\t
\n\t\t- \n\t\t\tY\n\t\t\tN\n\t\t\t5013432\n\t\t\t005462580202\n\t\t\t12827\n\t\t
\n\t\n\t\n\t\t- \n\t\t\tY\n\t\t\tN\n\t\t\t5013427\n\t\t\t005462575202\n\t\t\t12827\n\t\t
\n\t\t- \n\t\t\tY\n\t\t\tN\n\t\t\t5013428\n\t\t\t005462576202\n\t\t\t12827\n\t\t
\n\t\n\t\n\t\t- \n\t\t\tY\n\t\t\tN\n\t\t\t5013424\n\t\t\t005462572202\n\t\t\t12827\n\t\t
\n\t\t- \n\t\t\tY\n\t\t\tN\n\t\t\t5013425\n\t\t\t005462573202\n\t\t\t12827\n\t\t
\n\t\t- \n\t\t\tY\n\t\t\tN\n\t\t\t5013426\n\t\t\t005462574202\n\t\t\t12827\n\t\t
\n\t\n \n \n \n \n 15FTBIF1UOB2EZ3RRJ9I\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:27:16\n"}}}},"description":""}},"operationId":"post_getrelatedaccounts"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/searchAccounts":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","nullable":true,"pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"firstName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's first name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Ed\"`","example":"Ed"},"middleName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's middle name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"W\"`","example":"W"},"lastName":{"type":"string","nullable":true,"minimum":1,"maximum":40,"description":"Account holder's last name. Special character support.\nPattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`)\nExample: `\"Harley\"`","example":"Harley"},"dateOfBirth":{"type":"string","format":"date","nullable":true,"description":"Account holder's birth date. This date is compared with the DOB product parameter when there is a minimum age requirement on the account.\nPattern: YYYY-MM-DD\nExample: `\"1980-01-01\"`","example":"1980-01-01"},"postalCode":{"type":"string","nullable":true,"minimum":5,"maximum":10,"pattern":"^[a-zA-Z0-9\\-\\ ]*$","description":"Account holder's postal code (ZIP code).\nPattern: `12345`, `12345-1234`, or `K1A-1A1`\nExample: `\"84121\"`","example":"84121"},"primaryPhone":{"type":"string","nullable":true,"minimum":10,"maximum":10,"description":"Account holder's primary phone number. When passing a value for this parameter, you must also pass `mobilePhoneCountryCode`.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\nExample: `\"8013656050\"`","example":"8013656050"},"otherPhone":{"type":"string","nullable":true,"minimum":10,"maximum":10,"description":"Account holder's secondary phone number. When passing a value for this parameter, you must also pass `mobilePhoneCountryCode`.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\nExample: `\"8013656050\"`","example":"8013656050"},"mobilePhone":{"type":"string","nullable":true,"minimum":10,"maximum":10,"description":"Account holder's mobile phone number. When passing a value for this parameter, you must also pass `mobilePhoneCountryCode`.\nPattern: Validation according to the value in `mobilePhoneCountryCode`.\nExample: `\"8013656050\"`","example":"8013656050"},"email":{"type":"string","format":"email","nullable":true,"description":"Account holder's email. This field is validated by Marshmallow.\n Pattern: Email address, 3–63 characters\nExample: `\"user@fakedomain.com\"`","example":"user@fakedomain.com"},"userData":{"type":"string","nullable":true,"minLength":1,"maxLength":50,"pattern":"^[a-zA-Z0-9_ ]*$","description":"Data supplied by the provider, from sources external to the system. This data will be stored in the system in association with this account. The most common use of this parameter is to track affiliate-marketing traffic. The data in this field can be added to an <>.\nPattern: Max 50 alphanumeric characters, underscores and spaces\nExample: `\"a4434gg44\"`","example":"a4434gg44"},"eextid":{"type":"string","nullable":true,"maximum":30,"pattern":"^[a-zA-Z0-9\\-]*$","description":"The `externalAccountId` that was passed in the account-creation call.\nPattern: Max 30 alphanumeric characters\nExample: `\"553b45sbs\"`","example":"553b45sbs"},"recordCnt":{"type":"integer","format":"int32","nullable":true,"minimum":10,"maximum":100,"description":"The maximum number of records per page to be returned.\nPattern: Positive integer `1-99999`\nExample: `100`","example":100},"page":{"type":"integer","format":"int32","default":1,"minimum":1,"maximum":100,"description":"The number of the page to retrieve.\nPattern: Integer value of `1` or greater\nExample: `3`","example":3},"mobilePhoneCountryCode":{"type":"string","nullable":true,"minimum":2,"maximum":4,"pattern":"^\\+[0-9]*$","description":"Account holder's mobile phone country code.\nPattern: A plus sign followed by 1–3 digits. See Phone Validation for valid values. \nExample: `\"+1\"`","example":"+1"}},"required":["transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Search Accounts","description":"Use the Search Accounts endpoint to find a customer account by passing at least one of the parameters. The data in the response is similar to what the <> search provides.\n\nTry Get Account by ID to specify a customer identifier and retrieve all associated accounts.\n\nFor the `recordCnt` parameter use these values to get the desired number of records per page:\n* **No value** — 50 records per page\n* **`1` through `100`** — The specified number of records per page\n* **Values over `100`** — 100 records per page\n","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"page":{"type":"integer","format":"int32","description":"The current page in the accounts list display"},"total_record_count":{"type":"string","description":"Number of records in the accounts list display"},"number_of_pages":{"type":"integer","format":"int32","description":"Total number of pages in the accounts list display"},"accounts":{"type":"array","description":"List of account objects","items":{"description":"Acts as a logical separator to discern a specific account","type":"object","properties":{"pmt_ref_no":{"type":"string","description":"A system-generated account number"},"first_name":{"type":"string","nullable":true,"description":"A person's first name as listed on the account"},"middle_name":{"type":"string","nullable":true,"description":"A person's middle name as listed on the account"},"last_name":{"type":"string","nullable":true,"description":"A person's last name as listed on the account"},"email":{"type":"string","nullable":true,"description":"The email address on a profile"},"status":{"type":"string","description":"The status of the account"},"active":{"type":"string","description":"Yes or no to flag an active account"},"galileo_account_number":{"type":"string","nullable":true,"description":"System-generated integer account number, also known as balance ID"},"product_id":{"type":"string","nullable":true,"description":"System-generated integer"},"group_id":{"type":"string","nullable":true,"description":"Integer value used for tracking the location (store, entity, etc...) where the customer was acquired. The group_id is set using the location and locationType parameters."},"application_date":{"type":"string","format":"date-time","nullable":true,"description":"The date an application was made to create an account"}},"required":["active","application_date","email","first_name","galileo_account_number","group_id","last_name","middle_name","pmt_ref_no","product_id","status"]}}},"required":["accounts","number_of_pages","page","total_record_count"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.027,\n \"response_data\": {\n \"page\": 1,\n \"total_record_count\": \"2\",\n \"number_of_pages\": 1,\n \"accounts\": [\n {\n \"pmt_ref_no\": \"001104889124\",\n \"first_name\": \"Mike\",\n \"middle_name\": \"\",\n \"last_name\": \"Karb\",\n \"email\": \"\",\n \"status\": \"N\",\n \"active\": \"Y\",\n \"galileo_account_number\": \"386812\",\n \"product_id\": \"88\",\n \"group_id\": \"5\",\n \"application_date\": \"2025-10-22 00:00:00\"\n },\n {\n \"pmt_ref_no\": \"001108510288\",\n \"first_name\": \"Michael\",\n \"middle_name\": \"J\",\n \"last_name\": \"Bluth\",\n \"email\": \"\",\n \"status\": \"N\",\n \"active\": \"Y\",\n \"galileo_account_number\": \"425566\",\n \"product_id\": \"88\",\n \"group_id\": \"5\",\n \"application_date\": \"2025-10-22 12:34:37\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"34AEHU05D99DVRFXVYA5\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:39:36\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.093\n \n 1\n 2\n 1\n \n \n 001104889124\n Mike\n \n Karb\n \n N\n Y\n 386812\n 88\n 5\n 2025-10-22 00:00:00\n \n \n 001108510288\n Michael\n J\n Bluth\n \n N\n Y\n 425566\n 88\n 5\n 2025-10-22 12:34:37\n \n \n \n \n \n \n TJS1D445GR3SMYXEYB9A\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:32:57\n"}}}},"description":""}},"operationId":"post_searchaccounts"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/setOverdraftLimit":{"post":{"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","x-minimum":"1","x-maximum":"60","description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"overdraftAccountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> of the overdraft account.\nPattern: PRN \nExample: `\"074103447228\"`","example":"074103447228"},"amount":{"type":"number","description":"Currency amount as a whole or decimal amount.\nPattern: Positive integer or decimal number\nExample: `100.00`, `100`, or `100.73`","example":25.5}},"required":["amount","overdraftAccountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"old_overdraft_limit":{"type":"string","description":"The previous overdraft limit for the account"},"new_overdraft_limit":{"type":"string","description":"The updated overdraft limit for the account"}}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.145,\n \"response_data\": {\n \"previous_overdraft_limit\": \"25.00\",\n \"old_overdraft_limit\": \"50.00\"\n },\n \"echo\": {\n \"provider_timestamp\": \"\",\n \"provider_transaction_id\": null,\n \"transaction_id\": \"JR91JXZLN7FXDLRILSEP\"\n },\n \"rtoken\": \"8a7b6c5d-4e3f-2g1h-0i9j-8k7l6m5n4o3p\",\n \"system_timestamp\": \"2026-04-10 13:05:01\"\n }"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.145\n \n 25.00\n 50.00\n \n \n \n \n JR91JXZLN7FXDLRILSEP \n \n 8a7b6c5d-4e3f-2g1h-0i9j-8k7l6m5n4o3p\n 2026-04-10 13:05:01\n"}}}},"description":""}},"summary":"Set Overdraft Limit","tags":["Overdraft"],"description":"Use the Set Overdraft Limit endpoint to modify the overdraft limit for the specified account.","operationId":"post_setoverdraftlimit"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getPromontoryBankList":{"post":{"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"balance":{"type":"object","description":"A dictionary with keys being an account number (PRN) and values that are balance data objects","additionalProperties":{"type":"array","items":{"description":"Balance information","type":"object","properties":{"balance_date":{"type":"string","format":"date-time","description":"Timestamp when the balance was retrieved."},"bank_name":{"type":"string","description":"Name of the bank."},"balance_amount":{"type":"number","format":"float","description":"Account balance"},"rate_tier_balance":{"type":"number","format":"float","description":"Rate-tier balance"},"accrued_interest":{"type":"number","format":"float","description":"Accrued interest amount"},"bank_number":{"type":"integer","format":"int32","description":"Bank number"},"rate_record_number":{"type":"integer","format":"int32","description":"Rate record number"}},"required":["accrued_interest","balance_amount","balance_date","bank_name","bank_number","rate_record_number","rate_tier_balance"]}}}},"required":["balance"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.424,\n \"response_data\": {\n \"balance\": {\n \"005461593202\": [\n {\n \"balance_date\": \"2025-07-15 00:00:00\",\n \"bank_name\": \"Test Bank 1\",\n \"balance_amount\": 1000,\n \"rate_tier_balance\": 0,\n \"accrued_interest\": 20,\n \"bank_number\": 1,\n \"rate_record_number\": 1\n }\n ],\n \"005461594202\": [\n {\n \"balance_date\": \"2025-07-15 00:00:00\",\n \"bank_name\": \"Test Bank 1\",\n \"balance_amount\": 1111,\n \"rate_tier_balance\": 0,\n \"accrued_interest\": 20,\n \"bank_number\": 1,\n \"rate_record_number\": 1\n }\n ]\n }\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"30f00606-2104-4b49-9ae1-5e715bd0fec3\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 15:55:26\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.411\n \n \n \n \n 2025-07-15 00:00:00\n Test Bank 1\n 1000\n 0\n 20\n 1\n 1\n \n \n \n \n 2025-07-15 00:00:00\n Test Bank 1\n 1111\n 0\n 20\n 1\n 1\n \n \n \n \n \n \n \n d70e621a-94ca-4a85-9e77-e68db629bf5d\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 15:56:20\n"}}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <> or <> of the account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"startDate":{"type":"string","format":"date","nullable":true,"description":"The beginning date for the date range, either a date or a date-time.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"},"endDate":{"type":"string","format":"date","nullable":true,"description":"The end date for the date range, either a date or a date-time. Must be equal to or later than `startDate`.\nPattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss\nExample: `\"2016-01-01\"`","example":"2016-01-01"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Miscellaneous"],"summary":"Get Promontory Bank List","parameters":[],"description":"Use the Get Promontory Bank List endpoint to retrieve a list of Promontory Bank (now IntraFi) balances. This endpoint returns a list of the banks that are included in the deposit sweeps. Omit `startDate` and `endDate` parameters to retrieve a list of the most recent bank balances; otherwise, you receive all bank-balance records within the specified date range.","operationId":"post_getpromontorybanklist"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/chargeOffAccount":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account. Do not use the PRN if more than one card has ever been associated with this account.\nPattern: PAN or PRN\nExample: `\"074103447228\"`","example":"074103447228"},"chargeOffDetails":{"type":"string","nullable":true,"description":"A JSON object containing a list of charge-off details. See the endpoint description above for details.\nPattern: JSON format (list of dictionaries)\nExample: `\"[{\"chargeOffAmount\": 2.6, \"chargeOffReason\": 5}, {\"chargeOffAmount\": 4.75, \"chargeOffReason\": 2}]\"`","example":"[{\"chargeOffAmount\": 2.6, \"chargeOffReason\": 5}, {\"chargeOffAmount\": 4.7, \"chargeOffReason\": 2}]\""},"closeAssociatedAccounts":{"type":"integer","format":"int32","enum":[0,1],"nullable":true,"description":"If `accountNo` is a secondary account, pass `1` to close all accounts with the same balance ID.\nPattern: Integer\nExample: `1`","example":1}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Charge Off Account","description":"Use the Charge Off Account endpoint to charge off the specified account (sweep funds and set balance to `0.00`) and move the account to `status: R` (charged off).\n\nThese are the rules for using the `chargeOffDetails` parameter:\n* `chargeOffDetails` accepts a JSON-formatted list with `chargeOffAmount` and `chargeOffReason` as the two keys.\n* The only valid values for `chargeOffReason` are the numerals 1-13, as shown in the `chargeOffReason` table.\n* `chargeOffAmount` is a float that must be greater than `0`. If you pass `0` the request will fail.\n* `chargeOffAmount` is required when `chargeOffReason` does not equal `1`.\n\nExample: `[{\"chargeOffAmount\": 2.6, \"chargeOffReason\": 5}, {\"chargeOffAmount\": 4.75, \"chargeOffReason\": 2}]`\n\nTo recover a charged-off account use the Recover Charged-Off Account endpoint.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","type":"object","properties":{}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.022,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"A43ZQ5ZMR4XALONBW1G3\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:48:07\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.049\n \n \n \n \n BE8Z7F78YSAS0EA1TBA8\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:42:45\n"}}}},"description":""}},"operationId":"post_chargeoffaccount"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getIngoCustomerId":{"post":{"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"ingo_sso_token":{"type":"string","description":"SSO Token used for SDK"},"ingo_customer_id":{"type":"string","description":"ID for Ingo Money system"},"registered_card":{"description":"Card used to register with the Ingo system","type":"object","properties":{"status":{"type":"string","description":"status of card registered on Ingo System"},"card_id":{"type":"integer","format":"int32","description":"card_id of card registered on Ingo System"},"card_number":{"type":"string","description":"Masked card number of card registered on Ingo System"}},"required":["card_id","card_number","status"]},"ingo_message":{"type":"string","description":"Additional error messages from Ingo system"}},"required":["ingo_customer_id","ingo_message","ingo_sso_token","registered_card"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.022,\n \"response_data\": {\n \"ingo_customer_id\": \"xxxxxx\",\n \"ingo_sso_token\": \"xxxxxxxx\",\n \"registered_card\": {\n \"card_number\": \"xxxxxxxxx\",\n \"card_id\": \"xxxxxxxxx\",\n \"status\": \"xxxxxxxxx\"\n }\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"5ZMBW1G3R4ZQONAXAL34\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-14 10:45:17\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 2025-07-14 10:45:17\n \n xxxxxx\n xxxxxxxx\n \n xxxxxxxxx\n xxxxxxxxx\n xxxxxxxxx\n \n \n 0.407\n \n QBW3R4ZM34NA1GLOXA5Z\n \n \n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n"}}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"mobileDeviceId":{"type":"string","minimum":1,"maximum":255,"description":"Unique identifier for a cardholder's device using the Ingo SDK. For mobile apps.\nPattern: 1–255 characters\nExample: `\"123456789009876\"`","example":"123456789009876"}},"required":["accountNo","mobileDeviceId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"tags":["Miscellaneous"],"summary":"Get Ingo Customer ID","parameters":[],"description":"Use the Get Ingo Customer ID to retrieve customer identity information from third-party provider Ingo Money. Use the Ingo customer ID as needed.","operationId":"post_getingocustomerid"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/switchProduct":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^.+$","description":"The <>, <> or <> of the account.\nPattern: PAN, PRN, or CAD\nExample: `\"074103447228\"`","example":"074103447228"},"prodId":{"type":"integer","format":"int32","description":"The new product ID for the account.\nPattern: Integer\nExample: `4444`","example":4444},"doReissue":{"type":"string","default":"N","enum":["Y","N"],"description":"Controls whether to reissue the card. Default: `\"N\"`.\nPattern: String\nExample: `\"Y\"`","example":"Y"},"newPan":{"type":"string","enum":["Y","N"],"nullable":true,"description":"Controls whether to generate a new PAN for the reissued card.\nPattern: String\nExample: `\"Y\"`","example":"Y"},"newExpiryDate":{"type":"string","enum":["Y","N"],"nullable":true,"description":"Controls whether to generate a new expiry date for the reissued card. If `newPan: Y` then this value must be `\"Y\"`.\nPattern: String\nExample: `\"Y\"`","example":"Y"},"emboss":{"type":"string","enum":["Y","N"],"nullable":true,"description":"Controls whether to emboss the reissued card.\nPattern: String\nExample: `\"Y\"`","example":"Y"},"oldCardStatus":{"type":"string","enum":["C","D"],"nullable":true,"description":"Specifies the status to set for the card that is being replaced. Status is set by the emboss process. Default: blank\nPattern: String or blank\nExample: `\"D\"`","example":"D"}},"required":["accountNo","prodId","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Switch Product","description":"Use the Switch Product endpoint to change the product ID on the specified account to a new product ID. To control whether the product switch triggers a card reissue, set `doReissue`.\n\nFor `prodId` pass the new product ID. This endpoint is valid only for card-account products. For products that do not have a card, use Set Account Feature with `type: 3` to switch products.\n\nSoFi Tech Solutions recommends that you use the <> for `accountNo`; however, you can use the <> if only one card has ever been associated with the account.\n\nFor instructions on using this endpoint, see the Switching Products guide.\n\n> 📘 Note\n >\n> The `expiry_date` and `card_security_code` (CVV2) that are returned by the endpoint are not the new values. The new values are generated later by the emboss process. Call Get Card to retrieve the new values after the emboss process has run.\n\n","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"prod_id":{"type":"integer","format":"int32","description":"Identifier for the card's product"},"app_date":{"type":"string","nullable":true,"description":"Date the account's application was submitted"},"galileo_account_number":{"type":"string","nullable":true,"description":"System-generated account number, also known as the balance ID"},"new_emboss_uuid":{"type":"string","nullable":true,"description":"UUID for an emboss record that has not yet been sent to the embosser."},"active_flag":{"type":"string","description":"Indicates whether an account is active"},"bill_cycle_day":{"type":"string","nullable":true,"description":"Day of the month that the customer is billed"},"start_date":{"type":"string","format":"date","nullable":true,"description":"Date the account was activated"},"status":{"type":"string","description":"Status of the account"},"cards":{"type":"array","description":"List of cards associated with the account","items":{"type":"object","properties":{"card_id":{"type":"string","description":"Unique identifier for a card"},"emboss_uuid":{"type":"string","nullable":true,"description":"UUID for an emboss record that has been sent to the embosser. When this field is present outside the `embossed_cards` object, it contains the most recent emboss UUID."},"card_number":{"type":"string","description":"<>, usually masked"},"card_status":{"type":"string","nullable":true,"description":"Status of the card"},"card_security_code":{"type":"string","nullable":true,"description":"Card verification value (CVV2)"},"expiry_date":{"type":"string","format":"date","nullable":true,"description":"Expiration date of the card"},"external_card_id":{"type":"string","nullable":true,"description":"Partner-specified external card identifier"},"pin_fail_count":{"type":"string","nullable":true,"description":"The number of times a PIN entry failed"},"pin_fail_date":{"type":"string","format":"date-time","nullable":true,"description":"Last date a PIN fail was recorded"},"freeze_info":{"type":"object","properties":{"status":{"type":"string","nullable":true,"description":"Whether a card is frozen"},"start_date":{"type":"string","format":"date-time","nullable":true,"description":"Date-time when the card was frozen"},"end_date":{"type":"string","format":"date-time","nullable":true,"description":"Date-time for the card being unfrozen"}},"required":["end_date","start_date","status"]},"encrypted_card_number":{"type":"string","nullable":true,"description":"Encrypted PAN of the card"},"encrypted_expiry_date":{"type":"string","nullable":true,"description":"Encrypted expiration date of the card"},"embossed_cards":{"type":"array","description":"List of embossed card objects","items":{"type":"object","properties":{"created_date":{"type":"string","format":"date","description":"Date the card was created"},"emboss_uuid":{"type":"string","nullable":true,"description":"UUID for an emboss record that has been sent to the embosser. When this field is present outside the `embossed_cards` object, it contains the most recent emboss UUID."},"emboss_date":{"type":"string","format":"date","description":"Date the card was embossed"},"expiry_date":{"type":"string","format":"date-time","nullable":true,"description":"Expiration date of the card"},"status":{"type":"string","description":"Emboss status. For valid values see the Emboss Statuses enumeration."},"shipping_type":{"type":"string","nullable":true,"description":"Type of shipping used"}},"required":["created_date","emboss_date","shipping_type","status"]}},"spend_controls":{"type":"object","properties":{"available_credit":{"type":"string","nullable":true,"description":"Amount available to be charged to a credit card"},"single_use":{"type":"string","nullable":true,"description":"Indicates an alias credit card number, valid for one use"},"credit_limit":{"type":"string","nullable":true,"description":"Maximum outstanding balance allowed on a credit card"}},"required":["available_credit","credit_limit","single_use"]},"first_name":{"type":"string","description":"Cardholder first name"},"middle_name":{"type":"string","description":"Cardholder middle name"},"last_name":{"type":"string","description":"Cardholder last name"},"pmt_ref_no":{"type":"string","nullable":true,"description":"System-generated account number, also known as the PRN"},"status":{"type":"string","nullable":true,"description":"Whether a card is frozen"},"ssn":{"type":"string","nullable":true,"description":"Social Security number of the cardholder. This field is returned only if `CINFN` is set."}},"required":["card_id","card_number","embossed_cards","external_card_id","first_name","freeze_info","last_name","middle_name","pin_fail_count","pin_fail_date","pmt_ref_no"]}},"group_id":{"type":"string","nullable":true,"description":"Integer used for tracking the location (store, entity, etc.) where the customer was acquired. The `group_id` is set using the `location` and `locationType` parameters in enrollment endpoints."},"prn":{"type":"string","description":"System-generated account number, also known as the `pmt_ref_no`"}},"required":["active_flag","app_date","cards","galileo_account_number","group_id","prn","prod_id","status"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.463,\n \"response_data\": {\n \"prn\": \"999101084257\",\n \"prod_id\": 4444,\n \"app_date\": \"2025-01-25\",\n \"status\": \"N\",\n \"active_flag\": \"Y\",\n \"bill_cycle_day\": \"24\",\n \"group_id\": null,\n \"start_date\": \"2025-01-25\",\n \"galileo_account_number\": \"8888\",\n \"cards\": [\n {\n \"card_number\": \"525691XXXXXX6388\",\n \"expiry_date\": \"2026-12-25\",\n \"card_security_code\": \"123\",\n \"status\": \"N\",\n \"card_id\": \"2222\",\n \"external_card_id\": null,\n \"pmt_ref_no\": \"999101084257\",\n \"first_name\": \"Desiderius\",\n \"middle_name\": \"\",\n \"last_name\": \"Erasmus\",\n \"encrypted_card_number\": null,\n \"encrypted_expiry_date\": null,\n \"embossed_cards\": [\n {\n \"emboss_uuid\": \"c8b3f352-4eaa-439a-a8b2-a84737eac0de\",\n \"status\": \"N\",\n \"created_date\": \"2025-01-25\",\n \"emboss_date\": \"2025-01-25\",\n \"expiry_date\": \"2026-12-25\",\n \"shipping_type\": \"standard\"\n },\n {\n \"emboss_uuid\": \"5c2b14af-db98-446f-af65-63d35427fb83\",\n \"status\": \"Y\",\n \"created_date\": \"2025-01-25\",\n \"emboss_date\": \"2025-01-25\",\n \"expiry_date\": \"2026-12-25\",\n \"shipping_type\": \"standard\"\n }\n ],\n \"pin_fail_count\": \"0\",\n \"pin_fail_date\": null,\n \"freeze_info\": {\n \"status\": \"Unfrozen\",\n \"start_date\": null,\n \"end_date\": null\n },\n \"spend_controls\": {\n \"available_credit\": null,\n \"single_use\": null,\n \"credit_limit\": null\n },\n \"emboss_uuid\": \"5c2b14af-db98-446f-af65-63d35427fb83\",\n \"ssn\": \"999999999\"\n }\n ],\n \"new_emboss_uuid\": \"5c2b14af-db98-446f-af65-63d35427fb83\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"4332edea-a1f0-4dea-b7c4-a547e13c9b96\"\n },\n \"system_timestamp\": \"2024-06-11 07:50:11\",\n \"rtoken\": \"950fc40c-dc83-4148-9e74-f1c8c3408112\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n \n 0\n Success\n 0.463\n \n 999101084257\n 4444\n 2025-01-25\n N\n Y\n 24\n \n 2025-01-25\n 8888\n \n 525691XXXXXX6388\n 2026-12-25\n 123\n N\n 2222\n \n 999101084257\n Desiderius\n \n Erasmus\n \n \n \n c8b3f352-4eaa-439a-a8b2-a84737eac0de\n N\n 2025-01-25\n 2025-01-25\n 2026-12-25\n standard\n \n \n 5c2b14af-db98-446f-af65-63d35427fb83\n Y\n 2025-01-25\n 2025-01-25\n 2026-12-25\n standard\n \n 0\n \n \n Unfrozen\n \n \n \n \n \n \n \n \n 5c2b14af-db98-446f-af65-63d35427fb83\n 999999999\n \n 5c2b14af-db98-446f-af65-63d35427fb83\n \n \n \n \n 4332edea-a1f0-4dea-b7c4-a547e13c9b96\n \n 2024-06-11 07:50:11\n 950fc40c-dc83-4148-9e74-f1c8c3408112\n \n"}}}},"description":""}},"operationId":"post_switchproduct"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/setRoundupAccounts":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"},"linkedAccounts":{"type":"string","description":"A JSON object containing mappings between PRNs and the percentage of the roundup amount that the accounts receive. Specify the percentages as integers. The percentages must add up to 100.\nPattern: JSON string format\nExample: `\"{'123456789012': 58, '123456789000': 42}\"`","example":"{'123456789012': 58, '123456789000': 42}"},"expire":{"type":"string","enum":["Y","N"],"nullable":true,"description":"Expire the roundup feature. Default is `\"N\"`.\nPattern: String\nExample: `\"N\"`","example":"N"}},"required":["accountNo","linkedAccounts","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Set Roundup Accounts","description":"Use the Set Roundup Accounts endpoint to specify the roundup account for a consumer account, such as rounding up into a charity account. (To enable roundup for the account, call Set Account Feature with `type: 11`.) You can assign multiple roundup accounts to a single consumer account. The total percentage from all linked roundup accounts must equal 100.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"roundup_accounts":{"type":"array","description":"List of roundup accounts","items":{"description":"List containing mappings between accounts and the roundup percentage","type":"object","properties":{"account_no":{"type":"string","description":"The payment reference number for an account"},"roundup_percentage":{"type":"number","format":"float","description":"Percent of roundup amount linked to the account"}},"required":["account_no","roundup_percentage"]}}},"required":["roundup_accounts"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"echo\": {\n \"provider_timestamp\": null,\n \"provider_transaction_id\": \"\",\n \"transaction_id\": \"6537a656-9832-14bc-c329-a54ed08cd40f\"\n },\n \"processing_time\": 0.453,\n \"response_data\": {\n \"roundup_accounts\": [\n {\n \"account_no\": \"123456789014\",\n \"roundup_percentage\": 42.0\n },\n {\n \"account_no\": \"123456789016\",\n \"roundup_percentage\": 58.0\n }\n ]\n },\n \"rtoken\": \"1df28570-4184-6e4f-b654-f25f33c993b9\",\n \"system_timestamp\": \"2025-05-19 02:58:52\"\n}\n"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n \n \n \n 6537a656-9832-14bc-c329-a54ed08cd40f\n \n 0.453\n \n \n \n 123456789014\n 42.0\n \n \n 123456789016\n 58.0\n \n \n \n 1df28570-4184-6e4f-b654-f25f33c993b9\n 2025-05-19 02:58:52\n\n"}}}},"description":""}},"operationId":"post_setroundupaccounts"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getRoundupAccounts":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`","example":"074103447228"}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Get Roundup Accounts","description":"Use the Get Roundup Accounts endpoint to retrieve a record of all accounts linked to a roundup account and the contribution percentage from each account.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"roundup_accounts":{"type":"array","description":"List of roundup accounts","items":{"description":"List containing mappings between accounts and the roundup percentage","type":"object","properties":{"account_no":{"type":"string","description":"The payment reference number for an account"},"roundup_percentage":{"type":"number","format":"float","description":"Percent of roundup amount linked to the account"}},"required":["account_no","roundup_percentage"]}}},"required":["roundup_accounts"]}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"echo\": {\n \"provider_timestamp\": null,\n \"provider_transaction_id\": \"\",\n \"transaction_id\": \"37a65656-9852-41cc-a229-a54d40fed08c\"\n },\n \"processing_time\": 0.455,\n \"response_data\": {\n \"roundup_accounts\": [\n {\n \"account_no\": \"123456789012\",\n \"roundup_percentage\": 45.0\n },\n {\n \"account_no\": \"123456789011\",\n \"roundup_percentage\": 55.0\n }\n ]\n },\n \"rtoken\": \"0f21d785-1844-46df-a654-ff33c99325b9\",\n \"system_timestamp\": \"2025-05-19 01:58:52\"\n}\n"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n \n \n \n 37a65656-9852-41cc-a229-a54d40fed08c\n \n 0.455\n \n \n \n 123456789012\n 45.0\n \n \n 123456789011\n 55.0\n \n \n \n 0f21d785-1844-46df-a654-ff33c99325b9\n 2025-05-19 01:58:52\n\n"}}}},"description":""}},"operationId":"post_getroundupaccounts"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/recoverChargedOffAccount":{"post":{"tags":["Accounts and Cards"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> or <> of the account. Do not use the PRN if more than one cardhas ever been associated with this account.\nPattern: `PAN` or `PRN`\nExample: `\"074103447228\"`","example":"074103447228"},"chargeOffRecoveryAmt":{"type":"number","format":"float","minimum":0,"maximum":9999999.99,"description":"The amount to restore to the recovered account. Cannot be more than what the account contained when it was charged off.\nPattern: Monetary amount 0 or greater.\n Example: `100.00`, `100`, `100.73`","example":100},"newAccountStatus":{"type":"string","enum":["Z","N"],"description":"Account status for the recovered account. Only `\"N\"` (active) and `\"Z\"` (canceled without refund) are valid values.\n Pattern: String\n Example: `\"N\"`","example":"N"},"closureReason":{"type":"string","enum":["inactivity","paid_user","chargeoff","collection","deleted_fraud","external_application_fraud_first_party_synthetic_id","external_application_fraud_first_party_income_misrepresentation","external_application_fraud_first_party_employment_misrepresentation","external_application_fraud_first_party_other_misrepresentation","external_credit_fraud_first_party_loan_stacking","external_credit_fraud_first_party_forced_post_transaction","external_credit_fraud_first_party_bustout","external_credit_fraud_first_party_other","external_mule_fraud_first_party_witting_mule","external_mule_fraud_first_party_unwitting_mule","external_profile_level_application_fraud_third_party_id_theft_existing_member","external_profile_level_application_fraud_third_party_id_theft_unknown_entity","external_account_takeover_fraud_third_party_social_engineering_phishing","external_account_takeover_fraud_third_party_compromised_credentials","external_account_takeover_fraud_third_party_sim_swap","external_account_takeover_fraud_third_party_password_profile_recovery_exploits","external_account_takeover_fraud_third_party_other_account_takeover","external_account_unauthorized_transaction_third_party_family_friendly_fraud","external_account_unauthorized_transaction_third_party_elder_abuse_financial_exploitation","external_account_unauthorized_transaction_third_party_unemployment_benefit_fraud","external_account_unauthorized_transaction_third_party_compromised_account_number","external_account_unauthorized_transaction_third_party_other","external_account_unauthorized_transaction_third_party_compromised_card_number","external_account_unauthorized_transaction_third_party_lost_stolen","external_account_authorized_transaction_third_party_scam_charity","external_account_authorized_transaction_third_party_scam_investment","external_account_authorized_transaction_third_party_scam_goods_services","external_account_authorized_transaction_third_party_scam_jobs","external_account_authorized_transaction_third_party_scam_property_real_estate","external_account_authorized_transaction_third_party_scam_romance","external_account_authorized_transaction_third_party_scam_known_family_friend","external_account_authorized_transaction_third_party_scam_other","internal_asset_misappropriation_fraud","internal_theft_fraud_access_abuse","internal_member_information_abuse_theft","internal_insider_insider_collusion","internal_insider_outsider_collusion","paid_chargeoff","paid_collection","deleted_no_fraud","deceased"],"nullable":true,"description":"Specifies the account closure reason. See the Account Closure Reasons enumeration for valid values.\nPattern: String\nExample: `\"chargeoff\"`","example":"chargeoff"}},"required":["accountNo","chargeOffRecoveryAmt","newAccountStatus","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Recover Charged-Off Account","description":"Use the Recover Charged-Off Account endpoint to change a charged-off account (`status: R`) to another status (active or canceled without refund) and to restore the account balance. Using this endpoint is valid only when there was an outstanding positive balance at the time of charge-off.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","type":"object","properties":{}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.0278,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"O2SQCGXU0NUE6BIPQ3OA\"\n },\n \"rtoken\": \"81c16de0-5eda-4e2a-978e-3b08fce6g778\",\n \"system_timestamp\": \"2025-07-13 10:42:56\"\n}\n"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 2025-07-13 10:42:56\n \n 0.255\n \n O2SQCGXU0NUE6BIPQ3OA\n \n \n \n 1c16de0-5eda-4e2a-978e-3b08fce6g778\n"}}}},"description":""}},"operationId":"post_recoverchargedoffaccount"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/setAccountLevelAuthControl":{"post":{"description":"Use the Set Account-Level Auth Control endpoint to create or modify an account-level velocity control. Prior to calling this endpoint, call Get Auth Control to get the `controlId` for the control to set or modify. See Set Velocity Controls for instructions on using this endpoint.\n\nTo update existing velocity ALCs, see Updating velocity ALCs.","operationId":"post_setaccountlevelauthcontrol","parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"accountNo":{"description":"The <> for the account. Do not use the <> or <>.\nPattern: 12-digit numeric string\nExample: `\"344101254935\"`","example":"344101254935","pattern":"^.+$","type":"string"},"amount":{"description":"The amount of the new limit. If this parameter is not populated when creating a new control, then `transactionCount` is required\nPattern: Decimal number (14, 2)\nExample: `500.00`","example":500,"nullable":true,"type":"number"},"apiLogin":{"description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999","type":"string"},"apiTransKey":{"description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g","type":"string"},"controlId":{"description":"The control ID of the velocity control to set or modify, as returned by Get Auth Control.\nPattern: Integer, max 18 digits\nExample: 10492","example":10492,"type":"integer"},"endDate":{"description":"End date-time for the control. Must be later than `startDate`. Cannot be in the past. Default: `3000-01-01 00:00:00`. \nPattern: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD\nExample: `\"2022-03-10 23:59:59\"`","example":"2024-03-10 23:59:59","format":"date","nullable":true,"type":"string"},"mccControls":{"description":"A list of one or more MCC ranges, including standalone values, to apply the velocity control to. Format is `['XXXX', 'YYYY-ZZZZ', 'AAAA-BBBB']`. When updating a velocity control with an MCC range, specify the entire range: `['YYYY-ZZZZ']`. Max 100 ranges.\nPattern: List of MCCs either alone or in a range.\nExample: `['2000', '3000-3999', '4567']`","example":["2000","0900-3000","4567"],"items":{"pattern":"^(?!(?:0000)$)\\d{4}-(?!(?:0000)$)\\d{4}|(?!(?:0000)$)\\d{4}$","type":"string"},"maxItems":100,"minItems":1,"nullable":true,"type":"array"},"startDate":{"description":"Start date-time for the control. Can be set up to six months in the future. Cannot be in the past. Must be earlier than `endDate`. Default: Current system time \nPattern: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD\nExample: `\"2022-03-03 00:00:00\"`","example":"2024-03-03 00:00:00","format":"date","nullable":true,"type":"string"},"transactionCount":{"description":"New number of transactions to permit. If this parameter is not populated when creating a new control, then `amount` is required.\nPattern: Integer, maximum 18 digits\nExample: `5`","example":5,"nullable":true,"type":"integer"},"transactionId":{"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000","maxLength":60,"minLength":1,"type":"string"}},"required":["accountNo","controlId","transactionId","apiLogin","apiTransKey","providerId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"echo":{"anyOf":[{"additionalProperties":false,"properties":{"provider_timestamp":{"description":"Store a related timestamp for reporting and troubleshooting purposes","format":"date-time","nullable":true,"type":"string"},"provider_transaction_id":{"description":"Secondary transaction identifier (generated by a provider)","nullable":true,"type":"string"},"transaction_id":{"description":"An ID that represents an API transaction","nullable":true,"type":"string"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure that contains transaction ID information"},"errors":{"description":"A list of errors generated while the request was processed","items":{"type":"string"},"type":"array"},"processing_time":{"description":"The time elapsed in processing the transaction","nullable":true,"type":"number"},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","additionalProperties":false,"properties":{},"type":"object"},"rtoken":{"description":"A system-generated ID used for tracking","nullable":true,"type":"string"},"status":{"description":"The condition of a process or response","nullable":true,"type":"string"},"status_code":{"description":"The response status code. May return a string for some statuses.","nullable":true,"type":"integer"},"system_timestamp":{"description":"A system generated timestamp","format":"date-time","nullable":true,"type":"string"}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"],"type":"object"},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.111,\n \"response_data\": [],\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"bbe1dd0a-9ae5-4a98-9626-66997d9e250f\"\n },\n \"system_timestamp\": \"2024-03-10 10:57:04\",\n \"rtoken\": \"893003ca-7bc5-4fa6-84c5-0b533e376322\"\n}\n"}}},"application/xml":{"examples":{"response":{"value":"\n\n \n \n \n bbe1dd0a-9ae5-4a98-9626-66997d9e250f\n \n 0.111\n \n 893003ca-7bc5-4fa6-84c5-0b533e376322\n Success\n 0\n 2024-03-10 10:57:04\n"}}}},"description":"Successful response"}},"summary":"Set Account-Level Auth Control ","tags":["Account-Level Controls"]},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getAuthControl":{"post":{"description":"Use the Get Auth Control endpoint to retrieve the velocity control details and their control IDs—at either the product level or account level, with or without MCC ranges. \n\nSee Retrieving velocity limits for instructions on using this endpoint.","operationId":"post_getauthcontrol","parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"accountNo":{"description":"The <> for the account. Do not use the <> or <>. Pass this value to retrieve all of the account-level velocity controls for this account. If this parameter is not populated then `prodId` must be populated.\nPattern: PRN (12-digit numeric string)\nExample: `\"344101254935\"`","example":"344101254935","nullable":true,"pattern":"^.+$","type":"string"},"apiLogin":{"description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999","type":"string"},"apiTransKey":{"description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g","type":"string"},"beginningMcc":{"description":"The start of the MCC range for the control. If this parameter is populated, then `endMcc` and `accountNo` must be populated.\nPattern: 3–4 digit integer, no leading zero\nExample: 3000","example":3000,"maximum":1000000000000000000,"minimum":1,"nullable":true,"type":"integer"},"controlId":{"description":"The system-generated identifier for the auth-level velocity control. When this parameter is populated then either `prodId` or `accountNo` must also be populated.\nPattern: Integer, max 18 digits\nExample: 102","example":102,"nullable":true,"type":"integer"},"endMcc":{"description":"The end of the MCC range for the control. If this parameter is populated, then `beginningMcc` and `accountNo` must be populated.\nPattern: 3–4 digit integer, no leading zero\nExample: 3999","example":3999,"maximum":1000000000000000000,"minimum":1,"nullable":true,"type":"integer"},"prodId":{"description":"The system-generated identifier for the product. Pass this value to retrieve all of the product-level velocity controls for this product. If this parameter is not populated then `accountNo` must be populated. \nPattern: Integer\nExample: `15293`","example":15293,"nullable":true,"type":"integer"},"transactionId":{"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000","maxLength":60,"minLength":1,"type":"string"}},"required":["transactionId","apiLogin","apiTransKey","providerId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"echo":{"anyOf":[{"additionalProperties":false,"properties":{"provider_timestamp":{"description":"Store a related timestamp for reporting and troubleshooting purposes","format":"date-time","nullable":true,"type":"string"},"provider_transaction_id":{"description":"Secondary transaction identifier (generated by a provider)","nullable":true,"type":"string"},"transaction_id":{"description":"An ID that represents an API transaction","nullable":true,"type":"string"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure that contains transaction ID information"},"errors":{"description":"A list of errors generated while the request was processed","items":{"type":"string"},"type":"array"},"processing_time":{"description":"The time elapsed in processing the transaction","nullable":true,"type":"number"},"response_data":{"anyOf":[{"additionalProperties":false,"properties":{"auth_controls":{"description":"List of auth controls","items":{"additionalProperties":false,"properties":{"amount":{"description":"Total transaction amount allowed per period.","type":"number"},"amount_available":{"description":"Transaction amount available in the current period.","type":"number"},"amount_used":{"description":"Transaction amount used in the current period.","type":"number"},"beginning_mcc":{"description":"The initial MCC value for the range of this control. This field is present only when MCCs are specified for the control.","type":"integer"},"control_desc":{"description":"Description of the velocity control.","type":"string"},"control_id":{"description":"The identifier for the specific velocity control.","type":"integer"},"domestic_flag":{"description":"Whether this velocity control applies to domestic transactions, international transactions or both. **Y**—Domestic only; **N**—International only; **A**—Both","type":"string"},"end_date":{"description":"Ending date-time of the account-level velocity control. Not populated for product-level controls.","format":"date-time","type":"string"},"end_mcc":{"description":"The final MCC value for the range of this control. This field is present only when MCCs are specified for the control.","type":"integer"},"has_pin":{"description":"Whether the limit applies to PIN transactions, signature transactions or both. **Y**—PIN only; **N**—Signature only; **A**—Both","type":"string"},"period":{"description":"Timespan for the velocity control. xD (x days), xM (x months), 1T (one transaction).","type":"string"},"start_date":{"description":"Starting date-time of the account-level velocity control. Not populated for product-level controls.","format":"date-time","type":"string"},"trans_type":{"description":"Type of transaction affected by the control: ATM, CAD, CBA, POS, VFT.","type":"string"},"transaction_count":{"description":"Number of allowed transactions per period.","type":"integer"},"transaction_count_available":{"description":"Number of transactions available in the current period.","type":"integer"},"transaction_count_used":{"description":"Number of transactions used in the current period.","type":"integer"}},"type":"object"},"type":"array"},"pmt_ref_no":{"description":"PRN. This field is populated when returning account-level velocity controls.","type":"string"},"prod_id":{"description":"This field is populated when returning product-level velocity controls.","type":"string"}},"required":["auth_controls"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure for the response data. It can be empty but usually will contain information."},"rtoken":{"description":"A system-generated ID used for tracking","nullable":true,"type":"string"},"status":{"description":"The condition of a process or response","nullable":true,"type":"string"},"status_code":{"description":"The response status code. May return a string for some statuses.","nullable":true,"type":"integer"},"system_timestamp":{"description":"A system generated timestamp","format":"date-time","nullable":true,"type":"string"}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"],"type":"object"},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.119,\n \"response_data\": {\n \"auth_controls\": [\n {\n \"control_id\": 1, \n \"amount\": 1000, \n \"transaction_count\": 6, \n \"start_date\": \"2024-03-10 13:00:00\", \n \"end_date\": \"3000-01-01 00:00:00\", \n \"trans_type\": \"ATM\", \n \"period\": \"1D\", \n \"domestic_flag\": \"Y\", \n \"has_pin\": \"A\",\n \"control_desc\": \"ATM Daily Limit, Domestic\",\n \"amount_used\": 500,\n \"amount_available\": 500,\n \"transaction_count_used\": null,\n \"transaction_count_available\": null\n }, \n {\n \"control_id\": 2, \n \"amount\": 600, \n \"transaction_count\": 24, \n \"start_date\": \"2024-03-17 00:00:00\", \n \"end_date\": \"2024-03-24 23:59:59\", \n \"trans_type\": \"ATM\", \n \"period\": \"1D\", \n \"domestic_flag\": \"N\", \n \"has_pin\": \"A\",\n \"control_desc\": \"ATM Daily Limit, International\",\n \"amount_used\": 200,\n \"amount_available\": 400,\n \"transaction_count_used\": null,\n \"transaction_count_available\": null\n }, \n {\n \"control_id\": 3, \n \"amount\": 500, \n \"transaction_count\": 3, \n \"start_date\": \"2024-03-10 13:00:00\", \n \"end_date\": \"2024-03-10 14:00:00\", \n \"trans_type\": \"ATM\", \n \"period\": \"1T\", \n \"domestic_flag\": \"A\", \n \"has_pin\": \"A\",\n \"control_desc\": \"Per-transaction ATM Limit\",\n \"amount_used\": 100,\n \"amount_available\": 0,\n \"transaction_count_used\": null,\n \"transaction_count_available\": null\n },\n {\n \"control_id\": 4, \n \"amount\": 2000, \n \"transaction_count\": 24, \n \"start_date\": \"2024-03-10 13:00:00\", \n \"end_date\": \"3000-01-01 00:00:00\", \n \"trans_type\": \"POS\", \n \"period\": \"7D\", \n \"domestic_flag\": \"A\", \n \"has_pin\": \"A\",\n \"control_desc\": \"Weekly POS Limit\",\n \"amount_used\": 500,\n \"amount_available\": 1500,\n \"transaction_count_used\": null,\n \"transaction_count_available\": 24\n },\n {\n \"control_id\": 4, \n \"beginning_mcc\": 5541,\n \"end_mcc\": 5542,\n \"amount\": 300, \n \"transaction_count\": 10, \n \"start_date\": \"2024-03-10 13:00:00\", \n \"end_date\": \"3000-01-01 00:00:00\", \n \"trans_type\": \"POS\", \n \"period\": \"7D\", \n \"domestic_flag\": \"A\", \n \"has_pin\": \"A\",\n \"control_desc\": \"Weekly POS Limit\",\n \"amount_used\": 100,\n \"amount_available\": 200,\n \"transaction_count_used\": 0,\n \"transaction_count_available\": 10\n },\n {\n \"control_id\": 4, \n \"beginning_mcc\": 3000,\n \"end_mcc\": 3299,\n \"amount\": 1500, \n \"transaction_count\": 1, \n \"start_date\": \"2024-03-10 13:00:00\", \n \"end_date\": \"3000-01-01 00:00:00\", \n \"trans_type\": \"POS\", \n \"period\": \"7D\", \n \"domestic_flag\": \"A\", \n \"has_pin\": \"A\",\n \"control_desc\": \"Weekly POS Limit\",\n \"amount_used\": 600,\n \"amount_available\": 900,\n \"transaction_count_used\": 1,\n \"transaction_count_available\": 0\n },\n {\n \"control_id\": 5, \n \"amount\": 10000, \n \"transaction_count\": 40, \n \"start_date\": \"2024-03-10 13:00:00\", \n \"end_date\": \"2024-03-31 23:59:59\", \n \"trans_type\": \"POS, ATM, CAD, CBD\", \n \"period\": \"1M\", \n \"domestic_flag\": \"A\", \n \"has_pin\": \"A\",\n \"control_desc\": \"Monthly Combined Limit\",\n \"amount_used\": 700,\n \"amount_available\": 1300,\n \"transaction_count_used\": 14,\n \"transaction_count_available\": 26\n },\n {\n \"control_id\": 5, \n \"beginning_mcc\": 5812,\n \"end_mcc\": 5814,\n \"amount\": 1000, \n \"transaction_count\": \"None\", \n \"start_date\": \"2024-03-10 13:00:00\", \n \"end_date\": \"3000-01-01 00:00:00\", \n \"trans_type\": \"POS, ATM, CAD, CBD\", \n \"period\": \"1M\", \n \"domestic_flag\": \"A\", \n \"has_pin\": \"A\",\n \"control_desc\": \"Monthly Combined Limit\",\n \"amount_used\": 300,\n \"amount_available\": 700,\n \"transaction_count_used\": null,\n \"transaction_count_available\": null\n },\n ], \n \"pmt_ref_no\": \"777777777777\"\n }, \n \"echo\": {\n \"provider_transaction_id\": \"\", \n \"provider_timestamp\": \"None\", \n \"transaction_id\": \"JXVANPHRZ1S726826FC5\"\n }\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n \n None\n \n JXVANPHRZ1S726826FC5\n \n 0.119\n \n \n \n 1000\n 500\n 500\n ATM Daily Limit, Domestic\n 1\n Y\n 3000-01-01 00:00:00\n A\n 1D\n 2024-03-10 13:00:00\n ATM\n 6\n \n \n \n \n 600\n 400\n 200\n ATM Daily Limit, International\n 2\n N\n 2024-03-24 23:59:59\n A\n 1D\n 2024-03-17 00:00:00\n ATM\n 24\n \n \n \n \n 500\n 0\n 100\n Per-transaction ATM Limit\n 3\n A\n 2024-03-10 14:00:00\n A\n 1T\n 2024-03-10 13:00:00\n ATM\n 3\n \n \n \n \n 2000\n 1500\n 500\n Weekly POS Limit\n 4\n A\n 3000-01-01 00:00:00\n A\n 7D\n 2024-03-10 13:00:00\n POS\n 24\n 24\n \n \n \n 300\n 200\n 100\n 5541\n Weekly POS Limit\n 4\n A\n 3000-01-01 00:00:00\n 5542\n A\n 7D\n 2024-03-10 13:00:00\n POS\n 10\n 10\n 0\n \n \n 1500\n 900\n 600\n 3000\n Weekly POS Limit\n 4\n A\n 3000-01-01 00:00:00\n 3299\n A\n 7D\n 2024-03-10 13:00:00\n POS\n 1\n 0\n 1\n \n \n 10000\n 1300\n 700\n Monthly Combined Limit\n 5\n A\n 2024-03-31 23:59:59\n A\n 1M\n 2024-03-10 13:00:00\n POS, ATM, CAD, CBD\n 40\n 26\n 14\n \n \n 1000\n 700\n 300\n 5812\n Monthly Combined Limit\n 5\n A\n 3000-01-01 00:00:00\n 5814\n A\n 1M\n 2024-03-10 13:00:00\n POS, ATM, CAD, CBD\n None\n \n \n \n \n 777777777777\n \n Success\n 0\n"}}}},"description":"Successful response"}},"summary":"Get Auth Control","tags":["Account-Level Controls"]},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getMccControls":{"post":{"description":"Use the Get MCC Controls endpoint to retrieve the <> controls for either a product ID or an account (PRN). See Set MCC Controls for instructions on using this endpoint.","operationId":"post_getmcccontrols","parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"accountNo":{"description":"The <> for the account. Do not use the <> or <>. Pass this value to retrieve all of the account-level MCC controls for this account. If this parameter is not populated then `prodId` must be populated.\nPattern: PRN (12-digit numeric string)\nExample: `\"074103447228\"`","example":"074103447228","nullable":true,"pattern":"^$|^([0-9]{12})$","type":"string"},"apiLogin":{"description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999","type":"string"},"apiTransKey":{"description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g","type":"string"},"prodId":{"description":"The system-generated identifier for the product. Pass this value to retrieve all of the product-level MCC controls for this product. If this parameter is not populated then `accountNo` must be populated. \nPattern: Integer\nExample: `15293`","example":15293,"nullable":true,"type":"integer"},"transactionId":{"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000","maxLength":60,"minLength":1,"type":"string"}},"required":["transactionId","apiLogin","apiTransKey","providerId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"echo":{"anyOf":[{"additionalProperties":false,"properties":{"provider_timestamp":{"description":"Store a related timestamp for reporting and troubleshooting purposes","format":"date-time","nullable":true,"type":"string"},"provider_transaction_id":{"description":"Secondary transaction identifier (generated by a provider)","nullable":true,"type":"string"},"transaction_id":{"description":"An ID that represents an API transaction","nullable":true,"type":"string"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure that contains transaction ID information"},"errors":{"description":"A list of errors generated while the request was processed","items":{"type":"string"},"type":"array"},"processing_time":{"description":"The time elapsed in processing the transaction","nullable":true,"type":"number"},"response_data":{"anyOf":[{"additionalProperties":false,"properties":{"mcc_controls":{"description":"List of MCC controls","items":{"additionalProperties":false,"properties":{"beginning_mcc":{"description":"The first MCC in the range.","type":"integer"},"deny_allow_flag":{"description":"Whether the control is DENY (`d`) or ALLOW (`a`).","type":"string"},"end_date":{"description":"Ending date-time of the account-level control. Not populated for product-level controls.","type":"string"},"end_mcc":{"description":"The last MCC in the range. If the control contains only one MCC, this field is either blank or the same value as `begMcc`.","type":"integer"},"online_only":{"description":"Whether the control applies to online (card not present) transactions only. **Y**—Online only; **N**—All transactions","type":"string"},"start_date":{"description":"Starting date-time of the account-level control. Not populated for product-level controls.","type":"string"}},"required":["beginning_mcc","deny_allow_flag","end_mcc","online_only"],"type":"object"},"type":"array"},"pmt_ref_no":{"description":"The PRN of the account. Returned only when `accountNo` was passed in the original call.","type":"string"},"product_id":{"description":"The product ID. Returned only when `prodId` was passed in the original call.","type":"integer"}},"required":["mcc_controls"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure for the response data. It can be empty but usually will contain information."},"rtoken":{"description":"A system-generated ID used for tracking","nullable":true,"type":"string"},"status":{"description":"The condition of a process or response","nullable":true,"type":"string"},"status_code":{"description":"The response status code. May return a string for some statuses.","nullable":true,"type":"integer"},"system_timestamp":{"description":"A system generated timestamp","format":"date-time","nullable":true,"type":"string"}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"],"type":"object"},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.049,\n \"response_data\": {\n \"mcc_controls\": [\n {\n \"beginning_mcc\": 9754,\n \"end_mcc\": 9754,\n \"deny_allow_flag\": \"d\",\n \"online_only\": \"N\"\n },\n {\n \"beginning_mcc\": 9100,\n \"end_mcc\": 9200,\n \"deny_allow_flag\": \"d\",\n \"online_only\": \"N\"\n },\n {\n \"beginning_mcc\": 7995,\n \"end_mcc\": 7995,\n \"deny_allow_flag\": \"d\",\n \"online_only\": \"Y\"\n },\n {\n \"beginning_mcc\": 7800,\n \"end_mcc\": 7802,\n \"deny_allow_flag\": \"d\",\n \"online_only\": \"N\"\n },\n {\n \"beginning_mcc\": 7297,\n \"end_mcc\": 7297,\n \"deny_allow_flag\": \"d\",\n \"online_only\": \"Y\"\n },\n {\n \"beginning_mcc\": 7273,\n \"end_mcc\": 7273,\n \"deny_allow_flag\": \"d\",\n \"online_only\": \"N\"\n },\n {\n \"beginning_mcc\": 6540,\n \"end_mcc\": 6540,\n \"deny_allow_flag\": \"d\",\n \"online_only\": \"N\"\n },\n {\n \"beginning_mcc\": 6536,\n \"end_mcc\": 6538,\n \"deny_allow_flag\": \"d\",\n \"online_only\": \"N\"\n },\n {\n \"beginning_mcc\": 6529,\n \"end_mcc\": 6535,\n \"deny_allow_flag\": \"d\",\n \"online_only\": \"N\"\n }\n ],\n \"product_id\": 4444\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"94cf4daa-f6cc-4c02-ad59-3f5f80198969\"\n },\n \"system_timestamp\": \"2024-03-14 14:08:24\",\n \"rtoken\": \"2a2a0a4d-f423-4f22-bab2-e4e4b19d6412\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n \n \n \n 94cf4daa-f6cc-4c02-ad59-3f5f80198969\n \n 0.049\n \n \n \n 9754\n d\n 9754\n N\n \n \n 9100\n d\n 9200\n N\n \n \n 7995\n d\n 7995\n Y\n \n \n 7800\n d\n 7802\n N\n \n \n 7297\n d\n 7297\n Y\n \n \n 7273\n d\n 7273\n N\n \n \n 6540\n d\n 6540\n N\n \n \n 6536\n d\n 6538\n N\n \n \n 6529\n d\n 6535\n N\n \n \n 4444\n \n 2a2a0a4d-f423-4f22-bab2-e4e4b19d6412\n Success\n 0\n 2024-03-14 14:08:24\n"}}}},"description":"Successful response"}},"summary":"Get MCC Controls","tags":["Account-Level Controls"]},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getMerchantControls":{"post":{"description":"Use the Get Merchant Controls endpoint to retrieve merchant ID (MID) controls for either the product ID or the specified account. See Set Merchant ID Controls for instructions on using this endpoint.","operationId":"post_getmerchantcontrols","parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"accountNo":{"description":"The <> for the account. Do not use the <> or <>. Pass this value to retrieve all of the account-level <> controls for this account. If this parameter is not populated then `prodId` must be populated.\nPattern: PRN (12-digit numeric string)\nExample: `\"074103447228\"`","example":"074103447228","nullable":true,"pattern":"^$|^([0-9]{12})$","type":"string"},"apiLogin":{"description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999","type":"string"},"apiTransKey":{"description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g","type":"string"},"prodId":{"description":"The system-generated identifier for the product. Pass this value to retrieve all of the product-level MID controls for this product. If this parameter is not populated then `accountNo` must be populated.\nPattern: Integer\nExample: `15293`","example":15293,"nullable":true,"type":"integer"},"transactionId":{"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000","maxLength":60,"minLength":1,"type":"string"}},"required":["transactionId","apiLogin","apiTransKey","providerId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"echo":{"anyOf":[{"additionalProperties":false,"properties":{"provider_timestamp":{"description":"Store a related timestamp for reporting and troubleshooting purposes","format":"date-time","nullable":true,"type":"string"},"provider_transaction_id":{"description":"Secondary transaction identifier (generated by a provider)","nullable":true,"type":"string"},"transaction_id":{"description":"An ID that represents an API transaction","nullable":true,"type":"string"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure that contains transaction ID information"},"errors":{"description":"A list of errors generated while the request was processed","items":{"type":"string"},"type":"array"},"processing_time":{"description":"The time elapsed in processing the transaction","nullable":true,"type":"number"},"response_data":{"anyOf":[{"additionalProperties":false,"properties":{"merchant_controls":{"description":"List of merchant controls","items":{"additionalProperties":false,"properties":{"deny_allow_flag":{"description":"Whether the control is DENY (`d`) or ALLOW (`a`).","type":"string"},"end_date":{"description":"Ending date-time of the account-level control. Not populated for product-level controls.","format":"date-time","type":"string"},"merchant_id":{"description":"Merchant ID. If the value passed has fewer than 15 characters, the system adds spaces at the end until it has 15 characters.","type":"string"},"start_date":{"description":"Starting date-time of the account-level control. Not populated for product-level controls.","format":"date-time","type":"string"}},"required":["deny_allow_flag","merchant_id"],"type":"object"},"type":"array"},"pmt_ref_no":{"description":"The PRN of the account. Returned only when `accountNo` was passed in the original call.","type":"string"},"product_id":{"description":"The product ID. Returned only when `prodId` was passed in the original call.","type":"integer"}},"required":["merchant_controls"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure for the response data. It can be empty but usually will contain information."},"rtoken":{"description":"A system-generated ID used for tracking","nullable":true,"type":"string"},"status":{"description":"The condition of a process or response","nullable":true,"type":"string"},"status_code":{"description":"The response status code. May return a string for some statuses.","nullable":true,"type":"integer"},"system_timestamp":{"description":"A system generated timestamp","format":"date-time","nullable":true,"type":"string"}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"],"type":"object"},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.036,\n \"response_data\": {\n \"merchant_controls\": [\n {\n \"merchant_id\": \"N344572049563 \",\n \"start_date\": \"2024-03-14 14:06:15\",\n \"end_date\": \"3000-01-01 00:00:00\",\n \"deny_allow_flag\": \"a\"\n },\n {\n \"merchant_id\": \"342243575458673\",\n \"start_date\": \"2024-03-14 14:05:57\",\n \"end_date\": \"3000-01-01 00:00:00\",\n \"deny_allow_flag\": \"a\"\n }\n ],\n \"pmt_ref_no\": \"777777777777\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"a6f1914f-ecbf-4baa-83cf-1f72ecea77f4\"\n },\n \"system_timestamp\": \"2024-03-14 14:06:27\",\n \"rtoken\": \"88c78804-b22d-4cd0-854c-00fed242accd\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n \n \n \n a6f1914f-ecbf-4baa-83cf-1f72ecea77f4\n \n 0.036\n \n \n \n a\n 3000-01-01 00:00:00\n N344572049563 \n 2024-03-14 14:06:15\n \n \n a\n 3000-01-01 00:00:00\n 342243575458673\n 2024-03-14 14:05:57\n \n \n 777777777777\n \n 88c78804-b22d-4cd0-854c-00fed242accd\n Success\n 0\n 2024-03-14 14:06:27\n"}}}},"description":"Successful response"}},"summary":"Get Merchant Controls","tags":["Account-Level Controls"]},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/setAccountLevelMccControls":{"post":{"description":"Use the Set Account-Level MCC Controls endpoint to create or modify account-level <> controls. See Set MCC Controls for instructions on using this endpoint.","operationId":"post_setaccountlevelmcccontrols","parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"accountNo":{"description":"The PRN for the account. Do not use the CAD or PAN.\nPattern: PRN (12-digit numeric string)\nExample: `\"344101254935\"`","example":"344101254935","pattern":"^.+$","type":"string"},"allowDeny":{"description":"Whether the MCC range is ALLOW (`a`) or DENY (`d`). This parameter is required for new controls but for updates it should be blank.\nPattern: `a` or `d`\nExample: `\"d\"`","enum":["a","d"],"example":"d","nullable":true,"type":"string"},"apiLogin":{"description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999","type":"string"},"apiTransKey":{"description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g","type":"string"},"endDate":{"description":"End date-time for the control. Must be later than `startDate`. Cannot be in the past. Default: `3000-01-01 00:00:00`. \nPattern: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD\nExample: `\"2024-03-10 23:59:59\"`","example":"2024-03-10 23:59:59","format":"date","nullable":true,"type":"string"},"mccControls":{"description":"A list of one or more MCC ranges, including standalone values. Format is `['XXXX', 'YYYY-ZZZZ', 'AAAA-BBBB']`. When updating an MCC control, specify the entire range: `['YYYY-ZZZZ']`. Max 100 ranges.\nPattern: List of 4-digit numbers either alone or in a range.\nExample: `['2000', '3000-4000', '4567']`","example":["2000","0900-3000","4000-5000"],"items":{"pattern":"^(?!(?:0000)$)\\d{4}-(?!(?:0000)$)\\d{4}|(?!(?:0000)$)\\d{4}$","type":"string"},"maxItems":100,"minItems":1,"type":"array"},"onlineOnly":{"description":"Whether the control applies only to online (card not present) transactions. Default: `N`.\nPattern: `Y` or `N`\nExample: `\"Y\"`","enum":["Y","N"],"example":"Y","nullable":true,"type":"string"},"startDate":{"description":"Start date-time for the control. Can be set up to six months in the future. Cannot be in the past. Must be earlier than `endDate`. Default: Current system time\nPattern: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD\nExample: `\"2024-03-03 00:00:00\"`","example":"2024-03-03 00:00:00","format":"date","nullable":true,"type":"string"},"transactionId":{"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000","maxLength":60,"minLength":1,"type":"string"}},"required":["accountNo","mccControls","transactionId","apiLogin","apiTransKey","providerId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"echo":{"anyOf":[{"additionalProperties":false,"properties":{"provider_timestamp":{"description":"Store a related timestamp for reporting and troubleshooting purposes","format":"date-time","nullable":true,"type":"string"},"provider_transaction_id":{"description":"Secondary transaction identifier (generated by a provider)","nullable":true,"type":"string"},"transaction_id":{"description":"An ID that represents an API transaction","nullable":true,"type":"string"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure that contains transaction ID information"},"errors":{"description":"A list of errors generated while the request was processed","items":{"type":"string"},"type":"array"},"processing_time":{"description":"The time elapsed in processing the transaction","nullable":true,"type":"number"},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","additionalProperties":false,"properties":{},"type":"object"},"rtoken":{"description":"A system-generated ID used for tracking","nullable":true,"type":"string"},"status":{"description":"The condition of a process or response","nullable":true,"type":"string"},"status_code":{"description":"The response status code. May return a string for some statuses.","nullable":true,"type":"integer"},"system_timestamp":{"description":"A system generated timestamp","format":"date-time","nullable":true,"type":"string"}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"],"type":"object"},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.111,\n \"response_data\": [],\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"bbe1dd0a-9ae5-4a98-9626-66997d9e250f\"\n },\n \"system_timestamp\": \"2024-03-10 10:57:04\",\n \"rtoken\": \"893003ca-7bc5-4fa6-84c5-0b533e376322\"\n}\n"}}},"application/xml":{"examples":{"response":{"value":"\n\n \n \n \n bbe1dd0a-9ae5-4a98-9626-66997d9e250f\n \n 0.111\n \n 893003ca-7bc5-4fa6-84c5-0b533e376322\n Success\n 0\n 2024-03-10 10:57:04\n"}}}},"description":"Successful response"}},"summary":"Set Account-Level MCC Controls","tags":["Account-Level Controls"]},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/setAccountLevelMerchantControl":{"post":{"description":"Use the Set Account-Level Merchant Control endpoint to create or modify an account-level merchant ID (MID) control. See Set Merchant ID Controls for instructions on using this endpoint.","operationId":"post_setaccountlevelmerchantcontrol","parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"accountNo":{"description":"The <> for the account. Do not use the <> or <>.\nPattern: PRN (12-digit numeric string)\nExample: `\"344101254935\"`","example":"344101254935","pattern":"^.+$","type":"string"},"allowDeny":{"description":"Whether the merchant ID is ALLOW (`a`) or DENY (`d`). This parameter is required for new controls but optional for updates.\nPattern: `a` or `d`\nExample: `\"d\"`","enum":["a","d"],"example":"d","nullable":true,"type":"string"},"apiLogin":{"description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999","type":"string"},"apiTransKey":{"description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g","type":"string"},"endDate":{"description":"End date-time for the control. Must be later than `startDate`. Cannot be in the past. Default: `3000-01-01 00:00:00`. \nPattern: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD\nExample: `\"2024-03-10 23:59:59\"`","example":"2024-03-10 23:59:59","format":"date","nullable":true,"type":"string"},"merchantId":{"description":"The merchant ID. Not case-sensitive.\nPattern: Max 15 alphanumeric characters\nExample: `\"000534LECR08003\"`","example":"000534LECR08003","pattern":"^[A-Za-z0-9]{1,15}$","type":"string"},"startDate":{"description":"Start date-time for the control. Can be set up to six months in the future. Cannot be in the past. Must be earlier than `endDate`. Default: Current system time \nPattern: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD\nExample: `\"2024-03-03 00:00:00\"`","example":"2024-03-03 00:00:00","format":"date","nullable":true,"type":"string"},"transactionId":{"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000","maxLength":60,"minLength":1,"type":"string"}},"required":["accountNo","merchantId","transactionId","apiLogin","apiTransKey","providerId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"echo":{"anyOf":[{"additionalProperties":false,"properties":{"provider_timestamp":{"description":"Store a related timestamp for reporting and troubleshooting purposes","format":"date-time","nullable":true,"type":"string"},"provider_transaction_id":{"description":"Secondary transaction identifier (generated by a provider)","nullable":true,"type":"string"},"transaction_id":{"description":"An ID that represents an API transaction","nullable":true,"type":"string"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure that contains transaction ID information"},"errors":{"description":"A list of errors generated while the request was processed","items":{"type":"string"},"type":"array"},"processing_time":{"description":"The time elapsed in processing the transaction","nullable":true,"type":"number"},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","additionalProperties":false,"properties":{},"type":"object"},"rtoken":{"description":"A system-generated ID used for tracking","nullable":true,"type":"string"},"status":{"description":"The condition of a process or response","nullable":true,"type":"string"},"status_code":{"description":"The response status code. May return a string for some statuses.","nullable":true,"type":"integer"},"system_timestamp":{"description":"A system generated timestamp","format":"date-time","nullable":true,"type":"string"}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"],"type":"object"},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.111,\n \"response_data\": [],\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"bbe1dd0a-9ae5-4a98-9626-66997d9e250f\"\n },\n \"system_timestamp\": \"2024-03-10 10:57:04\",\n \"rtoken\": \"893003ca-7bc5-4fa6-84c5-0b533e376322\"\n}\n"}}},"application/xml":{"examples":{"response":{"value":"\n\n \n \n \n bbe1dd0a-9ae5-4a98-9626-66997d9e250f\n \n 0.111\n \n 893003ca-7bc5-4fa6-84c5-0b533e376322\n Success\n 0\n 2024-03-10 10:57:04\n"}}}},"description":"Successful response"}},"summary":"Set Account-Level Merchant Control","tags":["Account-Level Controls"]},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/getRtfAccountRelationship":{"post":{"tags":["Corporate Credit and RTF"],"parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"apiLogin":{"type":"string","description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","minimum":1,"maximum":60,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000"},"accountNo":{"type":"string","pattern":"^$|^([0-9]{12}|[0-9]{16})$","description":"The <> for either an RTF funding or RTF spending account. Do not use the <> or <>.\nPattern: 12-digit numeric string\nExample: `\"344101254935\"`","example":"074103447228"},"page":{"type":"integer","format":"int32","default":1,"nullable":true,"minimum":1,"maximum":999999,"description":"The number of the page to retrieve.\nPattern: Integer value of `1` or greater\nExample: `3`","example":3},"recordCnt":{"type":"integer","format":"int32","nullable":true,"minimum":1,"maximum":99999,"description":"The maximum number of records per page to be returned.\nPattern: Positive integer `1-99999`\nExample: `100`","example":100}},"required":["accountNo","transactionId","apiLogin","apiTransKey","providerId"]}}}},"summary":"Get RTF Account Relationship","description":"Use the Get <> Account Relationship endpoint to retrieve either the RTF spending accounts that are associated with an RTF funding account, or the RTF funding account that is associated with an RTF spending account.\n\nFor instructions on using this endpoint see Creating Real-Time Funding Accounts.","responses":{"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"description":"A structure for the response data. It can be empty but usually will contain information.","type":"object","properties":{"funding_account":{"description":"The funding account associated with the RTF spending account.","type":"object","properties":{"pmt_ref_no":{"type":"string","description":"The payment reference number of the account."},"status":{"type":"string","description":"The status of the account. See Account Statuses for valid values."},"active":{"type":"string","description":"Whether the account is active: `Y` or `N`"},"galileo_account_number":{"type":"string","description":"Balance ID for the account."},"product_id":{"type":"string","description":"The identifier for the product that this account belongs to."}},"required":["active","galileo_account_number","product_id","status"]},"spending_accounts":{"type":"array","description":"Contains a list of RTF spending accounts associated with the RTF funding account.","items":{"type":"object","properties":{"pmt_ref_no":{"type":"string","description":"The payment reference number of the account."},"status":{"type":"string","description":"The status of the account. See Account Statuses for valid values."},"active":{"type":"string","description":"Whether the account is active: `Y` or `N`"},"galileo_account_number":{"type":"string","description":"Balance ID for the account."},"product_id":{"type":"string","description":"The identifier for the product that this account belongs to."}},"required":["active","galileo_account_number","product_id","status"]}},"funding_account_prn":{"type":"string","description":"The PRN of the funding account."},"spending_account_prn":{"type":"string","description":"The PRN of the spending account."},"spending_account_count":{"type":"integer","format":"int32","description":"Number of spending accounts returned."},"page":{"type":"integer","format":"int32","description":"The page number to be retrieved in the context of recordset paging"},"total_record_count":{"type":"integer","format":"int32","description":"Number of records in the accounts list display"},"number_of_pages":{"type":"integer","format":"int32","description":"Total number of pages in the accounts list display"}}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n\t\"status_code\": 0,\n\t\"status\": \"Success\",\n\t\"processing_time\": 0.081,\n\t\"response_data\": {\n \t\"spending_account_count\": 2,\n \t\"page\": 1,\n \t\"total_record_count\": 2,\n \t\"number_of_pages\": 1,\n \t\"spending_accounts\": [\n \t{\n \t\"pmt_ref_no\": \"999102798106\",\n \t\"product_id\": \"4444\",\n \t\"galileo_account_number\": \"7000398\",\n \t\"status\": \"N\",\n \t\"active\": \"Y\"\n \t},\n \t{\n \t\"pmt_ref_no\": \"999102798262\",\n \t\"product_id\": \"4444\",\n \t\"galileo_account_number\": \"7000555\",\n \t\"status\": \"N\",\n \t\"active\": \"Y\"\n \t}\n \t],\n \t\"funding_account_prn\": \"999102798098\"\n\t},\n\t\"echo\": {\n \t\"provider_transaction_id\": \"\",\n \t\"provider_timestamp\": null,\n \t\"transaction_id\": \"b0465cf0-c32a-4dbc-8c6e-011cff4e20af\"\n\t},\n\t\"system_timestamp\": \"2023-07-12 15:57:45\",\n\t\"rtoken\": \"af1be148-1c61-447b-8848-52469c75dd83\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n 0\n Success\n 0.081\n \n 2\n 1\n 2\n 1\n \n 999102798106\n 4444\n 7000398\n N\n Y\n \n \n 999102798262\n 4444\n 7000555\n N\n Y\n \n 999102798098\n \n \n \n \n b0465cf0-c32a-4dbc-8c6e-011cff4e20af\n \n 2023-07-12 15:57:45\n af1be148-1c61-447b-8848-52469c75dd83\n"}}}},"description":""}},"operationId":"post_getrtfaccountrelationship"},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/deleteAccountLevelAuthControl":{"post":{"description":"Use the Delete Account-Level Auth Control endpoint to delete one velocity <>. To delete a velocity control with MCCs, you must specify the full range in `beginningMcc` and `endMcc`.","operationId":"post_deleteaccountlevelauthcontrol","parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"accountNo":{"description":"The <> for the account. Do not use the <> or <>.\nPattern: 12-digit numeric string\nExample: `\"344101254935\"`","example":"344101254935","pattern":"^.+$","type":"string"},"apiLogin":{"description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999","type":"string"},"apiTransKey":{"description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g","type":"string"},"beginningMcc":{"description":"The start of the MCC range for the control to delete.\nPattern: 3–4 digit integer, no leading zero\nExample: 3000","example":3000,"maximum":9999,"minimum":1,"nullable":true,"type":"integer"},"controlId":{"description":"The control ID of the velocity control to delete, as returned by Get Auth Control.\nPattern: Integer, max 18 digits\nExample: `10492`","example":10492,"type":"integer"},"endMcc":{"description":"The end of the MCC range for the control to delete.\nPattern: 3–4 digit integer, no leading zero\nExample: 3999","example":3999,"maximum":9999,"minimum":1,"nullable":true,"type":"integer"},"transactionId":{"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for idempotency. A UUID is preferred.\nPattern: Maximum 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","example":"123e4567-e89b-12d3-a456-426614174000","maxLength":60,"minLength":1,"type":"string"}},"required":["accountNo","controlId","transactionId","apiLogin","apiTransKey","providerId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"echo":{"anyOf":[{"additionalProperties":false,"properties":{"provider_timestamp":{"description":"Store a related timestamp for reporting and troubleshooting purposes","format":"date-time","nullable":true,"type":"string"},"provider_transaction_id":{"description":"Secondary transaction identifier (generated by a provider)","nullable":true,"type":"string"},"transaction_id":{"description":"An ID that represents an API transaction","nullable":true,"type":"string"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"],"type":"object"},{"nullable":true,"type":"object"}],"description":"A structure that contains transaction ID information"},"errors":{"description":"A list of errors generated while the request was processed","items":{"type":"string"},"type":"array"},"processing_time":{"description":"The time elapsed in processing the transaction","nullable":true,"type":"number"},"response_data":{"description":"A structure for the response data. This endpoint does not return response data, so it will always be empty.","additionalProperties":false,"properties":{},"type":"object"},"rtoken":{"description":"A system-generated ID used for tracking","nullable":true,"type":"string"},"status":{"description":"The condition of a process or response","nullable":true,"type":"string"},"status_code":{"description":"The response status code. May return a string for some statuses.","nullable":true,"type":"integer"},"system_timestamp":{"description":"A system generated timestamp","format":"date-time","nullable":true,"type":"string"}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"],"type":"object"},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.153,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"07ad9c4b-d652-4473-b730-67e4c8507e97\"\n },\n \"system_timestamp\": \"2024-03-13 15:27:01\",\n \"rtoken\": \"caff25ca-80a0-4dea-b0b5-3851c599276c\"\n}"}}},"application/xml":{"examples":{"response":{"value":"\n\n \n \n \n 07ad9c4b-d652-4473-b730-67e4c8507e97\n \n 0.153\n \n caff25ca-80a0-4dea-b0b5-3851c599276c\n Success\n 0\n 2024-03-13 15:27:01\n"}}}},"description":"Successful response"}},"summary":"Delete Account-Level Auth Control ","tags":["Account-Level Controls"]},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/deleteAccountLevelMccControl":{"post":{"description":"Use the Delete Account-Level MCC Control endpoint to delete one MCC <>. You must specify the entire MCC range for the control in `mccControlStart` and `mccControlEnd`.","operationId":"post_deleteaccountlevelmcccontrol","parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"accountNo":{"description":"The <> for the account. Do not use the <> or <>.\nPattern: 12-digit numeric string\nExample: `\"344101254935\"`","example":"344101254935","pattern":"^.+$","type":"string"},"apiLogin":{"description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","example":"AbC123-9999","type":"string"},"apiTransKey":{"description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","example":"4sb62fh6w4h7w34g","type":"string"},"mccControlEnd":{"description":"The end of the MCC range for the control to delete.\nPattern: 3–4 digit integer, no leading zero\nExample: 3999","example":3999,"type":"integer"},"mccControlStart":{"description":"The start of the MCC range for the control to delete.\nPattern: 3–4 digit integer, no leading zero\nExample: 3000","example":3000,"type":"integer"},"transactionId":{"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). Might be used for