github.com/apremalal/vamps-core@v1.0.1-0.20161221121535-d430b56ec174/server/webapps/apiexplorer/swagger.json (about) 1 { 2 "swagger": "2.0", 3 "info": { 4 "description": "This single message API provide Account Status Validation as well as Account Ownership Validation based on request. If request contains Account ownership information it will be matched against Account Owner information on the account. \n", 5 "version": "v1", 6 "title": "Account Validation", 7 "termsOfService": "http://api.wellsfargo.com/terms/", 8 "contact": { 9 "name": "api-support", 10 "url": "http://api-team.wellsfargo.com/support/", 11 "email": "apiteam@api.wellsfargo.com" 12 }, 13 "license": { 14 "name": "API Wellsfargo license", 15 "url": "http://api.wellsfargo.com/license.html/" 16 } 17 }, 18 "basePath": "/avs", 19 "schemes": [ 20 "https" 21 ], 22 "paths": { 23 "/account-validations/status": { 24 "post": { 25 "tags": [ 26 "account-status" 27 ], 28 "summary": "Provides the ability for customers to know the status of Account for a transaction real-time. The Account Validation system will validate the request received from the customer and will return a valid response code.", 29 "parameters": [ 30 { 31 "schema": { 32 "$ref": "#/definitions/account_status_request" 33 }, 34 "description": "Account information to be validated", 35 "name": "body", 36 "required": true, 37 "in": "body" 38 } 39 ], 40 "responses": { 41 "200": { 42 "description": "OK or Successful operation", 43 "schema": { 44 "type": "object", 45 "items": { 46 "$ref": "#/definitions/account_status_response" 47 } 48 } 49 }, 50 "400": { 51 "description": "Bad Request", 52 "schema": { 53 "$ref": "#/definitions/Error" 54 } 55 }, 56 "401": { 57 "description": "Authentication Failed", 58 "schema": { 59 "$ref": "#/definitions/Error" 60 } 61 }, 62 "403": { 63 "description": "Forbidden Failed", 64 "schema": { 65 "$ref": "#/definitions/Error" 66 } 67 }, 68 "429": { 69 "description": "Too Many Requests", 70 "schema": { 71 "$ref": "#/definitions/Error" 72 } 73 }, 74 "500": { 75 "description": "Internal Server Error", 76 "schema": { 77 "$ref": "#/definitions/Error" 78 } 79 }, 80 "503": { 81 "description": "Service Unavailable", 82 "schema": { 83 "$ref": "#/definitions/Error" 84 } 85 }, 86 "default": { 87 "description": "unexpected error", 88 "schema": { 89 "$ref": "#/definitions/Error" 90 } 91 } 92 }, 93 "security": [ 94 { 95 "api_key": [] 96 } 97 ], 98 "deprecated": false 99 } 100 }, 101 "/account-validations/status-and-ownership": { 102 "post": { 103 "tags": [ 104 "account-ownership" 105 ], 106 "summary": "Provides the ability for customers to validate Account owner information for a transaction real-time. The Account Validation system will validate the request received from the customer and will return a valid response code.", 107 "description": "", 108 "parameters": [ 109 { 110 "schema": { 111 "$ref": "#/definitions/account_owner_status_request" 112 }, 113 "description": "Account information to be validated", 114 "name": "body", 115 "required": true, 116 "in": "body" 117 } 118 ], 119 "responses": { 120 "200": { 121 "description": "OK or uccessful operation", 122 "schema": { 123 "type": "object", 124 "items": { 125 "$ref": "#/definitions/account_owner_status_response" 126 } 127 } 128 }, 129 "400": { 130 "description": "Bad Request", 131 "schema": { 132 "$ref": "#/definitions/Error" 133 } 134 }, 135 "401": { 136 "description": "Authentication Failed", 137 "schema": { 138 "$ref": "#/definitions/Error" 139 } 140 }, 141 "403": { 142 "description": "Forbidden Failed", 143 "schema": { 144 "$ref": "#/definitions/Error" 145 } 146 }, 147 "407": { 148 "description": "Authentication Failed", 149 "schema": { 150 "$ref": "#/definitions/Error" 151 } 152 }, 153 "429": { 154 "description": "Too Many Requests", 155 "schema": { 156 "$ref": "#/definitions/Error" 157 } 158 }, 159 "500": { 160 "description": "Internal Server Error", 161 "schema": { 162 "$ref": "#/definitions/Error" 163 } 164 }, 165 "503": { 166 "description": "Service Unavailable", 167 "schema": { 168 "$ref": "#/definitions/Error" 169 } 170 }, 171 "default": { 172 "description": "unexpected error", 173 "schema": { 174 "$ref": "#/definitions/Error" 175 } 176 } 177 }, 178 "security": [ 179 { 180 "api_key": [] 181 } 182 ], 183 "deprecated": false, 184 "consumes": [ 185 "application/json" 186 ], 187 "produces": [ 188 "application/json" 189 ] 190 } 191 } 192 }, 193 "securityDefinitions": { 194 "api_key": { 195 "type": "apiKey", 196 "name": "api_key", 197 "in": "header" 198 } 199 }, 200 "definitions": { 201 "Error": { 202 "type": "object", 203 "required": [ 204 "errorCode", 205 "errorDesc" 206 ], 207 "properties": { 208 "errorCode": { 209 "type": "string", 210 "description": "error code", 211 "example": 1000 212 }, 213 "errorDesc": { 214 "type": "string", 215 "description": "error description", 216 "example": "loginId not found" 217 } 218 } 219 }, 220 "MatchCodeYNU": { 221 "type": "string", 222 "description": "Match Code, values can be Y, N, or U Y = The inquiry field closely or exactly matches the database. N = The inquiry field does not match the database. U = No identifying data is available in the database for the account provided." 223 }, 224 "MatchCodeYNUC": { 225 "type": "string", 226 "description": "Match Code, values can be Y, N, or U Y = The inquiry field closely or exactly matches the database. N = The inquiry field does not match the database. U = No identifying data is available in the database for the account provided. C = The inquiry field conditionally (partially) matches the database (see descriptions and examples for each element)." 227 }, 228 "account_status_res_obj": { 229 "type": "object", 230 "required": [ 231 "condition_code" 232 ], 233 "properties": { 234 "condition_code": { 235 "type": "string" 236 }, 237 "primary_status_code": { 238 "type": "string" 239 }, 240 "secondary_status_code": { 241 "type": "string" 242 }, 243 "additional_status_code": { 244 "type": "string" 245 }, 246 "number_of_returns": { 247 "type": "string" 248 }, 249 "last_return_date": { 250 "type": "string" 251 }, 252 "last_return_reason": { 253 "type": "string" 254 }, 255 "last_update": { 256 "type": "string" 257 }, 258 "add_closed_date": { 259 "type": "string" 260 }, 261 "previous_status": { 262 "type": "string" 263 } 264 } 265 }, 266 "account_status_response": { 267 "type": "object", 268 "required": [ 269 "request_id", 270 "request_status", 271 "bank_routing_number", 272 "bank_account_number" 273 ], 274 "properties": { 275 "request_id": { 276 "type": "string", 277 "description": "Identifier of API request message instance, to provide tracking. Echoed from Request." 278 }, 279 "request_status": { 280 "type": "string" 281 }, 282 "error_list": { 283 "type": "string" 284 }, 285 "bank_routing_number": { 286 "type": "string", 287 "description": "Routing number, echoed from Request", 288 "example": 1111000111 289 }, 290 "bank_account_number": { 291 "type": "string", 292 "description": "Account number, echoed from Request", 293 "example": 9998887777 294 }, 295 "account_status": { 296 "$ref": "#/definitions/account_status_res_obj", 297 "description": "Complex object it define basic account status." 298 } 299 } 300 }, 301 "account_owner_res_obj": { 302 "type": "object", 303 "required": [ 304 "condition_code", 305 "name_match", 306 "first_name_match", 307 "last_name_match", 308 "business_name_match" 309 ], 310 "properties": { 311 "condition_code": { 312 "type": "string" 313 }, 314 "name_match": { 315 "type": "string", 316 "$ref": "#/definitions/MatchCodeYNU" 317 }, 318 "first_name_match": { 319 "type": "string", 320 "$ref": "#/definitions/MatchCodeYNU" 321 }, 322 "last_name_match": { 323 "type": "string", 324 "$ref": "#/definitions/MatchCodeYNU" 325 }, 326 "middle_name_match": { 327 "type": "string", 328 "$ref": "#/definitions/MatchCodeYNU" 329 }, 330 "name_suffix_match": { 331 "type": "string", 332 "$ref": "#/definitions/MatchCodeYNU" 333 }, 334 "name_prefix_match": { 335 "type": "string", 336 "$ref": "#/definitions/MatchCodeYNU" 337 }, 338 "business_name_match": { 339 "type": "string", 340 "$ref": "#/definitions/MatchCodeYNUC" 341 }, 342 "full_address_match": { 343 "type": "string", 344 "$ref": "#/definitions/MatchCodeYNUC" 345 }, 346 "city_match": { 347 "type": "string", 348 "$ref": "#/definitions/MatchCodeYNUC" 349 }, 350 "state_match": { 351 "type": "string", 352 "$ref": "#/definitions/MatchCodeYNU" 353 }, 354 "zip_match": { 355 "type": "string", 356 "$ref": "#/definitions/MatchCodeYNUC" 357 }, 358 "home_phone_match": { 359 "type": "string", 360 "$ref": "#/definitions/MatchCodeYNUC" 361 }, 362 "work_phone_match": { 363 "type": "string", 364 "$ref": "#/definitions/MatchCodeYNUC" 365 }, 366 "ssn_match": { 367 "type": "string", 368 "$ref": "#/definitions/MatchCodeYNUC" 369 }, 370 "date_of_birth_match": { 371 "type": "string", 372 "$ref": "#/definitions/MatchCodeYNUC" 373 }, 374 "document_id_type_match": { 375 "type": "string", 376 "$ref": "#/definitions/MatchCodeYNU" 377 }, 378 "document_id_number_match": { 379 "type": "string", 380 "$ref": "#/definitions/MatchCodeYNUC" 381 }, 382 "document_issuer_match": { 383 "type": "string", 384 "$ref": "#/definitions/MatchCodeYNU" 385 }, 386 "overall_match_score": { 387 "type": "string", 388 "description": "0-100. Measure of how closely the inquiry attributes match the information in the Account Owner Elements Database. Derived by examining all information sent; incorporates name variations (for name fields), edit distances, abbreviations, phonetic encoding, and other matching algorithms." 389 }, 390 "primary_status_code": { 391 "type": "string", 392 "description": "Primary Status Code" 393 }, 394 "secondary_status_code": { 395 "type": "string", 396 "description": "Secondary Status Code" 397 }, 398 "additional_status_code": { 399 "type": "string", 400 "description": "Additional Status Code" 401 }, 402 "number_of_returns": { 403 "type": "string", 404 "description": "Number of Returns" 405 }, 406 "last_return_date": { 407 "type": "string", 408 "description": "Last Return Date MMDD" 409 }, 410 "last_return_reason": { 411 "type": "string", 412 "description": "Last Return Reason" 413 }, 414 "last_update": { 415 "type": "string", 416 "description": "Last Update YYYYMMDD" 417 }, 418 "add_closed_date": { 419 "type": "string", 420 "description": "Add Closed Date YYYYMMDD" 421 }, 422 "previous_status": { 423 "type": "string", 424 "description": "Previous Status" 425 }, 426 "FCRA_dispute": { 427 "type": "string", 428 "description": "FCRA Dispute. Required when applicable." 429 }, 430 "scored_account_reason1": { 431 "type": "string", 432 "description": "Stored Account Reason 1" 433 }, 434 "scored_account_reason2": { 435 "type": "string", 436 "description": "Stored Account Reason 2" 437 }, 438 "scored_account_reason3": { 439 "type": "string", 440 "description": "Stored Account Reason 3" 441 }, 442 "scored_account_reason4": { 443 "type": "string", 444 "description": "Stored Account Reason 4" 445 }, 446 "scored_account_reason5": { 447 "type": "string", 448 "description": "Stored Account Reason 5" 449 } 450 } 451 }, 452 "account_owner_status_response": { 453 "type": "object", 454 "required": [ 455 "request_id", 456 "request_status", 457 "bank_routing_number", 458 "bank_account_number" 459 ], 460 "properties": { 461 "request_id": { 462 "type": "string", 463 "description": "Request Id, echoed from Request." 464 }, 465 "request_status": { 466 "type": "string", 467 "description": "Generate by Channel Side." 468 }, 469 "error_list": { 470 "type": "string" 471 }, 472 "bank_routing_number": { 473 "type": "string", 474 "description": "Routing number, echoed from Request.", 475 "example": 1111000111 476 }, 477 "bank_account_number": { 478 "type": "string", 479 "description": "Account number, echoed from Request", 480 "example": 9998887777 481 }, 482 "account_status": { 483 "$ref": "#/definitions/account_status_res_obj", 484 "description": "Complex objet will return basic account Info." 485 }, 486 "account_owner": { 487 "$ref": "#/definitions/account_owner_res_obj", 488 "description": "Complex objet will return account ownership information." 489 } 490 } 491 }, 492 "account_status_request": { 493 "type": "object", 494 "required": [ 495 "request_id", 496 "baas_client_id", 497 "bank_routing_number", 498 "bank_account_number" 499 ], 500 "properties": { 501 "request_id": { 502 "type": "string", 503 "minimum": 1, 504 "maximum": 36, 505 "description": "Required. Identifier of API request message instance, to provide tracking. Length must be between 1 and 36" 506 }, 507 "baas_client_id": { 508 "type": "string", 509 "minimum": 16, 510 "maximum": 16, 511 "description": "Required. Channel Id of WF customer that request is on behalf of. Will be used for authorization and billing. Length must be 16." 512 }, 513 "bank_routing_number": { 514 "type": "string", 515 "minimum": 9, 516 "maximum": 9, 517 "description": "Required. Bank routing number (RTN, ABA). Length must be 9", 518 "example": 1111000111 519 }, 520 "bank_account_number": { 521 "type": "string", 522 "minimum": 17, 523 "maximum": 17, 524 "description": "Required. Bank account number. Do not pad with zeroes. Length must be 17.", 525 "example": 9998887777 526 } 527 } 528 }, 529 "account_owner_status_request": { 530 "type": "object", 531 "required": [ 532 "request_id", 533 "baas_client_id", 534 "bank_routing_number", 535 "bank_account_number", 536 "first_name", 537 "last_name", 538 "business_name" 539 ], 540 "properties": { 541 "request_id": { 542 "type": "string", 543 "minimum": 1, 544 "maximum": 36, 545 "description": "Required. Identifier of API request message instance, to provide tracking. Length must be between 1 and 36" 546 }, 547 "baas_client_id": { 548 "type": "string", 549 "minimum": 16, 550 "maximum": 16, 551 "description": "Required. Channel Id of WF customer that request is on behalf of. Will be used for authorization and billing. Length must be 16." 552 }, 553 "bank_routing_number": { 554 "type": "string", 555 "minimum": 9, 556 "maximum": 9, 557 "description": "Required. Bank routing number (RTN, ABA). Length must be 9", 558 "example": 1111000111 559 }, 560 "bank_account_number": { 561 "type": "string", 562 "minimum": 17, 563 "maximum": 17, 564 "description": "Required. Bank account number. Do not pad with zeroes. Length must be 17.", 565 "example": 9998887777 566 }, 567 "name_prefix": { 568 "type": "string", 569 "maximum": 4, 570 "description": "Optional. Name prefix. When applicable, maximum length can be 4." 571 }, 572 "first_name": { 573 "type": "string", 574 "maximum": 40, 575 "description": "Required - Either first_name and last_name should be present OR business_name should be present. When applicable maximum length can be 40." 576 }, 577 "middle_name": { 578 "type": "string", 579 "maximum": 40, 580 "description": "Optional. Middle name or middle initial (no period after). When applicable maximum length can be 40." 581 }, 582 "last_name": { 583 "type": "string", 584 "maximum": 40, 585 "description": "Required - Either first_name and last_name should be present OR business_name should be present. When applicable maximum length can be 40." 586 }, 587 "name_suffix": { 588 "type": "string", 589 "maximum": 4, 590 "description": "Optional. Name suffix. When applicable maximum length can be 4." 591 }, 592 "business_name": { 593 "type": "string", 594 "maximum": 87, 595 "description": "Required - Either first_name and last_name should be present OR business_name should be present. When applicable Business name maximum length can be 87." 596 }, 597 "address_line1": { 598 "type": "string", 599 "maximum": 40, 600 "description": "Optional. Street address line 1. When applicable maximum length can be 40." 601 }, 602 "address_line2": { 603 "type": "string", 604 "maximum": 40, 605 "description": "Optional. Street address line 1. When applicable maximum length can be 40." 606 }, 607 "city": { 608 "type": "string", 609 "maximum": 25, 610 "description": "Optional. City or locality. When applicable maximum length can be 25." 611 }, 612 "state": { 613 "type": "string", 614 "minimum": 2, 615 "maximum": 2, 616 "description": "Optional. State, Province, or other country sub-division. When applicable length must be 2." 617 }, 618 "zip": { 619 "type": "string", 620 "minimum": 5, 621 "maximum": 10, 622 "description": "Optional. Postal Code. When applicable length must be in range (4-9)." 623 }, 624 "home_phone": { 625 "type": "string", 626 "minimum": 10, 627 "maximum": 10, 628 "description": "Optional. Home phone number (can be mobile). When applicable, length must be 10." 629 }, 630 "work_phone": { 631 "type": "string", 632 "minimum": 10, 633 "maximum": 10, 634 "description": "Optional. Work phone number. When applicable. When applicable, length must be 10." 635 }, 636 "tax_id": { 637 "type": "string", 638 "maximum": 9, 639 "description": "Optional. Full Social Security Number (SSN), or Tax Identification Number (TIN), or last 4-digits only. When applicable, length must be either 4 or 9." 640 }, 641 "date_of_birth": { 642 "type": "string", 643 "minimum": 8, 644 "maximum": 8, 645 "description": "Optional. Date of birth, YYYYMMDD. When applicable, length must be 8." 646 }, 647 "document_type": { 648 "type": "string", 649 "minimum": 1, 650 "maximum": 1, 651 "description": "Optional. Document type, used to identify party being authorized." 652 }, 653 "document_id_number": { 654 "type": "string", 655 "maximum": 28, 656 "description": "Optional. Document number. When applicable, maximum length can be 28." 657 }, 658 "document_id_issuer": { 659 "type": "string", 660 "minimum": 2, 661 "maximum": 6, 662 "description": "Optional. Document issuer, state or other agency which issues document. When applicable length must be in range of (2-6)." 663 } 664 } 665 } 666 } 667 }