{"openapi":"3.1.0","info":{"title":"Payment Hub Api 2.0","version":"1.0"},"paths":{"/createTransfer":{"post":{"tags":["Transfers"],"summary":"Create Transfer","description":"> 👍 Availability\n>\n>Some of the field descriptions for this endpoint reference FedNow or Fedwire, which are future capabilities not yet available for clients.\n\nUse the Create Transfer endpoint to move funds between a source account and a destination account. You can use an active account link that was created by <a href=\"ref:paymenthub_post_createexternalaccountlink\" target=\"_blank\">Create External Account Link</a> or create a new one via the request.\n\nFor card transfers, the referenced external debit card link must have a validation status of `\"PASSED\"` before it can be used for transfers.\n\nFor new transfers: Omit the `returnDetails` field.\nFor payment returns: Include the `returnDetails` field with the original transaction reference.\nWhen `returnDetails` is present, the request initiates a return of the original transfer.","operationId":"paymenthub_post_createtransfer","parameters":[{"name":"x-gft-idempotency-key","in":"header","required":true,"schema":{"type":"string","format":"uuid4","title":"X-Gft-Idempotency-Key"}},{"name":"Authorization","in":"header","required":true,"description":"Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)","schema":{"type":"string","pattern":"^Basic [A-Za-z0-9+/]+=*$","example":"Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> associated with this transfer.\nPattern: PRN\nExample: `\"074103447228\"`"},"paymentMethod":{"description":"Payment network to use for the transfer.\nRail-specific validation: `CARD` requires the `sourceAccount` to be `GALILEO` and `creditOrDebit` to be `DEBIT` or `CREDIT`.\nExample: `\"CARD\"`","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"},"currencyAmount":{"description":"Request-side currency amount. Raises BadRequestException (400) on invalid client input.","properties":{"amount":{"type":"number","examples":[199.32]},"currency":{"type":"string","title":"Currency","description":"Currency code following ISO 4217 standard.\nValidation: Exactly 3 uppercase letters.\nPattern: ^[A-Z]{3}$\nExample: 'USD' (US Dollar), 'EUR' (Euro), 'GBP' (British Pound)","default":"USD","examples":["USD"]}},"type":"object","required":["amount"],"title":"CurrencyAmount"},"creditOrDebit":{"description":"Posting type indicating debit or credit.\n\n- DEBIT: Debit transaction (funds withdrawn)\n- CREDIT: Credit transaction (funds deposited)","type":"string","enum":["DEBIT","CREDIT"],"title":"PostingType"},"sourceAccount":{"description":"Identifies the account's role in the transaction.\n\nIf used as the **sourceAccount**, this is the account being debited. For push transfers (withdrawals), use the\nSoFi Tech Solutions account; for pull transfers (deposits), use the linked external account.\n\nIf used as the **destinationAccount**, this is the account being credited. For push transfers, use the linked\nexternal account; for pull transfers, use the SoFi Tech Solutions account.","properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/AccountRequest","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReference","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccount"}}},"destinationAccount":{"description":"Identifies the account's role in the transaction.\n\nIf used as the **sourceAccount**, this is the account being debited. For push transfers (withdrawals), use the\nSoFi Tech Solutions account; for pull transfers (deposits), use the linked external account.\n\nIf used as the **destinationAccount**, this is the account being credited. For push transfers, use the linked\nexternal account; for pull transfers, use the SoFi Tech Solutions account.","properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/AccountRequest","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReference","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccount"}}},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Externalid","description":"Client-defined identifier for tracking and reconciliation.\nPattern: Alphanumeric string\nExample: `My-Internal-ID-123`"},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purpose","description":"Reason for the transfer.\nPattern: Alphanumeric string\nValidation:\n- Default: Alphanumeric string\n- FEDWIRE: Limited to alphanumeric and special characters: @&/\\'\"\\`~()<>$#%+-={}*|[]^.,?!;:_\nExample: \"`Bill Payment`\""},"remittanceInfo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remittanceinfo","description":"Additional details about the transfer, such as an invoice number.\nPattern: Alphanumeric string\nValidation:\n- Default: Alphanumeric string\n- FEDWIRE: 1-140 characters, limited to alphanumeric and special characters: @&/\\'\"`~()<>$#%+-={}*|[]^.,?!;:_\nExample: \"`Invoice #456-ABC`\""},"returnDetails":{"anyOf":[{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Reason code describing why the transaction was returned.\nValidation:\n- FEDNOW: Required. Uses ISO 20022 External Status Reason Codes (pacs.002 StsRsnInf/Rsn/Cd). Must be 1-4 characters. Common codes include AC01 (Incorrect account number), AC03 (Invalid creditor account number), AC04 (Closed account number), AC06 (Blocked account), AC13 (Invalid debtor account type), AC14 (Invalid agent), AC15 (Account details changed), AG01 (Transaction forbidden). Refer to ISO 20022 ExternalCodeSets for the complete list of reason codes.","examples":["AC03","AC04"]},"additionalInfo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additionalinfo","description":"Optional additional context for the return.\nValidation:\n- FEDNOW: Maximum 105 characters. Maps to ISO 20022 pacs.002 StsRsnInf/AddtlInf.","examples":["Account closed by customer request"]},"originalTransactionId":{"type":"string","format":"uuid","title":"Originaltransactionid","description":"Reference to the original transaction being returned (transferId).","examples":["123e4567-e89b-12d3-a456-426614174000"]}},"type":"object","required":["originalTransactionId"],"title":"ReturnDetails","description":"Payment return information for reversing a previous transfer."},{"type":"null"}],"description":"Payment return information. If present, this request initiates a return/reversal of a previous transfer.\n\nWhen provided, the following fields take on return-specific meanings:\n- `currencyAmount`: The amount being returned (supports partial returns, must be less than or equal to the original amount)\n- `sourceAccount`: Account initiating the return.\n- `destinationAccount`: Account receiving the return.\n- `paymentMethod`: Payment rail used for the return.\n\nSee `ReturnDetails` class documentation for additional return fields and requirements."},"destinationEntities":{"anyOf":[{"properties":{"instructedAgent":{"anyOf":[{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification number. Required if bic is not provided.\nFor US banks: 9-digit ABA/RTN. For foreign banks: local clearing code.\nWhen provided without clearingSystemId, defaults to USABA."},"clearingSystemId":{"anyOf":[{"type":"string","enum":["USABA"],"title":"ClearingSystemId"},{"type":"null"}],"description":"Identifies the clearing system for the memberId.\nOnly applicable when memberId is provided. Defaults to USABA if omitted."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"SWIFT/BIC code of the financial institution.\nExactly 8 or 11 characters. Required if memberId is not provided."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier. 20-character alphanumeric code."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Financial institution name. Max 140 characters."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Financial institution address (bank location, not account owner)."}},"type":"object","title":"FinancialAgentRequest","description":"Financial institution involved in the transfer"},{"type":"null"}],"description":"The financial institution receiving the wire on FedWire.\nFor FedWire: clearingSystemId must be USABA and memberId must be a valid 9-digit ABA/RTN."},"intermediaryAgent1":{"anyOf":[{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification number. Required if bic is not provided.\nFor US banks: 9-digit ABA/RTN. For foreign banks: local clearing code.\nWhen provided without clearingSystemId, defaults to USABA."},"clearingSystemId":{"anyOf":[{"type":"string","enum":["USABA"],"title":"ClearingSystemId"},{"type":"null"}],"description":"Identifies the clearing system for the memberId.\nOnly applicable when memberId is provided. Defaults to USABA if omitted."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"SWIFT/BIC code of the financial institution.\nExactly 8 or 11 characters. Required if memberId is not provided."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier. 20-character alphanumeric code."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Financial institution name. Max 140 characters."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Financial institution address (bank location, not account owner)."}},"type":"object","title":"FinancialAgentRequest","description":"Financial institution involved in the transfer"},{"type":"null"}],"description":"Intermediary/correspondent bank in the SWIFT chain.\nAt least bic or memberId required. When present, instructedAgent is required."},"intermediaryAccount1":{"anyOf":[{"properties":{"number":{"type":"string","title":"Number","description":"Account number or IBAN."},"type":{"description":"Type of account number.\n- IBAN: International Bank Account Number, validated per ISO 13616\n- ACCOUNT_NUMBER: Standard account identifier (default when omitted)","default":"ACCOUNT_NUMBER","type":"string","enum":["IBAN","ACCOUNT_NUMBER"],"title":"AccountNumberType"}},"type":"object","required":["number"],"title":"AccountIdentification","description":"Account identification — account number or IBAN."},{"type":"null"}],"description":"Correspondent account at the intermediary bank.\nThe account the sending bank holds AT the intermediary (not the beneficiary's account)."}},"type":"object","title":"DestinationEntitiesRequest","description":"Agent routing for international wire transfers.\n\nOnly allowed for outbound international FedWire transfers.\nWhen intermediaryAgent1 is present, instructedAgent is required."},{"type":"null"}],"description":"Agent routing for outbound international FedWire transfers.\nContains the instructed agent (receiving FI on FedWire) and optional intermediary/correspondent bank in the payment chain.\nValidation:\n- Only allowed for outbound international FedWire transfers\n- When intermediaryAgent1 is present, instructedAgent is required\n- FedWire instructedAgent: clearingSystemId must be USABA, memberId must be valid ABA/RTN"},"isCrossBorder":{"type":"boolean","title":"Iscrossborder","description":"Indicates whether this is a cross-border (international) transfer.\nCurrently supported for FEDWIRE only.","default":false}},"type":"object","required":["accountNo","paymentMethod","currencyAmount","creditOrDebit","sourceAccount","destinationAccount","apiLogin","apiTransKey","providerId"],"title":"CreateTransferRequest","description":"Create a new payment transfer OR return a previous transfer.\n\nFor new transfers: Omit the `returnDetails` field.\nFor payment returns: Include the `returnDetails` field with the original transaction reference.\n\nWhen `returnDetails` is present, the request initiates a return of the original transfer.\nSee `ReturnDetails` class documentation for field meanings and return-specific behavior.\n\n**Character Set Restrictions for FEDWIRE and FEDNOW rails:**\n\nAll free-text fields (e.g. `purpose`, `remittanceInfo`, address fields, owner names, `bankName`)\nmust conform to the payment rail's character set when using FEDWIRE or FEDNOW:\n\n- **FEDWIRE**: Alphanumeric characters and special characters: @&/\\'\"` ~()<>$#%+-={}*|[]^.,?!;:_\n- **FEDNOW**: FedNow Service Character Set — alphanumeric, space, all printable ASCII special\n  characters (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~), and extended Latin characters (U+00C0–U+00FF)"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"transferId":{"type":"string","title":"Transferid","description":"Unique identifier assigned to the newly created transfer."}},"type":"object","required":["transferId"],"title":"CreateTransferResponse"},"examples":{"response":{"value":"{\n    \"transferId\": \"890e4567-e89b-12d3-a456-426614174222\"\n}"}}}}},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"No valid API credentials provided.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"403":{"description":"The provided API credential does not allow this operation.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}},"description":"Conflict"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}},"description":"Internal Server Error"},"502":{"description":"Bad Gateway.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}}}}},"/listTransfers":{"post":{"tags":["Transfers"],"summary":"List Transfers","description":"Use the List Transfer endpoint to get incoming and outgoing transfers attached to the provided account_no.All transfers created by <a href=\"ref:payhub_post_createTransfer\" target=\"_blank\">Create Transfer</a> will be returned as outgoing transfers.","operationId":"paymenthub_post_listtransfers","requestBody":{"content":{"application/json":{"schema":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"All transfers associated with this <<glossary:PRN>>.\nPattern: PRN\nExample: `074103447228`"},"filters":{"description":"Filters the list of transfers by direction, payment method, and status.","properties":{"direction":{"anyOf":[{"type":"string","enum":["IN","OUT"],"title":"Direction","description":"Direction of the transfer relative to the specified account.\n\n- IN: The specified account is the destination account of the transfer\n- OUT: The specified account is the source account of the transfer\n\nNote: Direction indicates transfer flow, but actual fund movement depends on the debit/credit indicator. For example, an incoming debit or outgoing credit may both result in funds leaving the specified account."},{"type":"null"}],"description":"Filters the list to include only incoming or outgoing transfers relative to the specified account.\nExample: `OUT`"},"paymentMethod":{"anyOf":[{"type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"},{"type":"null"}],"description":"Filters the list by the payment network used for the transfer relative to the specified account.\nExample: `ACH`"},"status":{"anyOf":[{"type":"string","enum":["CREATED","IN PROGRESS","COMPLETED","FAILED","PENDING REVIEW","SENT","ACCEPTED WITHOUT POST","BLOCKED","REJECTED","REQUESTED","REQUEST APPROVED","REQUEST REJECTED"],"title":"TransferStatus","description":"Status of the transaction.\n\n**For FedNow and FedWire transactions:**\n\n- CREATED: Initial state for transactions after creation via API call.\n- SENT: Outbound-only state indicating payment message (pacs.008 or pacs.004) successfully published to the payment network, awaiting pacs.002 status report.\n- IN PROGRESS: Transaction is being processed.\n- COMPLETED: Terminal success state. Payment network confirmed successful settlement via pacs.002 with ACSC or ACCC status.\n- FAILED: Terminal failure state. Transaction rejected by payment network or receiving FI initially.\n\n**For FedNow transactions only:**\n\n- ACCEPTED WITHOUT POST: Special intermediate state for outbound payments. Received pacs.002 with ACWP status - funds have settled but receiving Financial Institution requires additional investigation time before posting.\n- BLOCKED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Receiving FI sent pacs.002 with BLCK status - funds are blocked and will not be posted.\n- REJECTED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Received pacs.002 with RJCT status after investigation - funds must be returned via new pacs.004.\n- REQUESTED: Return has been requested (FedNow returns only).\n- REQUEST APPROVED: Return request has been approved (FedNow returns only).\n- REQUEST REJECTED: Return request has been rejected (FedNow returns only)."},{"type":"null"}],"description":"Filters the list by the current status of the transfers.\nExample: `COMPLETED`"}},"type":"object","title":"GetTransferFilters"},"dateFrom":{"type":"string","title":"Datefrom","description":"Start date for the transaction query. Defaults to the past 30 days from the current date.\nPattern: YYYY-MM-DD or ISO 8601 date-time\nExample: `\"2025-07-13\"`","examples":["2025-07-12","2025-07-12 16:20:00","2022-05-03T12:24:37-07:00"]},"dateTo":{"type":"string","title":"Dateto","description":"End date for the transaction query. Defaults to the current date and time.\nPattern: YYYY-MM-DD or ISO 8601 datetime\nExample: `\"2025-08-13\"`","examples":["2025-07-12","2025-07-12 16:20:00","2022-05-03T12:24:37-07:00"]},"limit":{"type":"integer","title":"Limit","description":"Maximum number of transfers to return in the response.\nPattern: Integer, max 15\nExample: 15","examples":[1,12,15]},"page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page","description":"Pass the `nextPage` token from a previous response to fetch the subsequent page.\nPattern: Alphanumeric token\nExample: `\"NO34BNT04TV234N6V274692376G32NNFNNF7988247923865017061N\"`","examples":["NO34BNT04TV234N6V274692376G32NNFNNF7988247923865017061N"]}},"type":"object","required":["accountNo","apiLogin","apiTransKey","providerId"],"title":"ListTransfersRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"nextPage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nextpage","description":"Token used to retrieve the next page of results. This field is null if there are no more results."},"data":{"items":{"properties":{"transferId":{"type":"string","title":"Transferid","description":"The unique identifier for the transfer."},"currencyAmount":{"description":"Response-side currency amount. Raises InternalServiceException (500) on invalid persisted data\n— bad values in response construction reflect server-side data integrity issues, not client error.","properties":{"amount":{"type":"number","examples":[199.32]},"currency":{"type":"string","title":"Currency","description":"Currency code following ISO 4217 standard.\nValidation: Exactly 3 uppercase letters.\nPattern: ^[A-Z]{3}$\nExample: 'USD' (US Dollar), 'EUR' (Euro), 'GBP' (British Pound)","default":"USD","examples":["USD"]}},"type":"object","required":["amount"],"title":"CurrencyAmountResponse"},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purpose","description":"Purpose provided for the transfer."},"createdDate":{"type":"string","title":"Createddate","description":"The date when the transfer was created or received, either a date or date-time."}},"type":"object","required":["transferId","currencyAmount","createdDate"],"title":"TransferHistoryData"},"type":"array","title":"Data","description":"A list of transfer history data objects."}},"type":"object","required":["nextPage","data"],"title":"ListTransfersResponse"},"examples":{"response":{"value":"{\n    \"nextPage\": \"123e4567-e89b-12d3-a456-4266100532\",\n    \"data\": [\n      {\n        \"transferId\": \"550e8400-e29b-41d4-a716-446655440000\",\n        \"currencyAmount\": {\n          \"amount\": 199.32,\n          \"currency\": \"USD\"\n        },\n        \"purpose\": \"Expense reimbursement\",\n        \"createdDate\": \"2025-11-11T07:19:24.485954-07:00\"\n      }\n    ]\n}"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"401":{"description":"No valid API credentials provided.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"403":{"description":"The provided API credential does not allow this operation.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"502":{"description":"Bad Gateway.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}}},"parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)","schema":{"type":"string","pattern":"^Basic [A-Za-z0-9+/]+=*$","example":"Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5"}}]}},"/getTransfer":{"post":{"tags":["Transfers"],"summary":"Get Transfer","description":"> 👍 Availability\n>\n>Some of the field descriptions for this endpoint reference FedNow or Fedwire, which are future capabilities not yet available for clients.\n\nUse the Get Transfer endpoint to retrieve information about an existing incoming or outgoing transferthat was initiated by the <a href=\"ref:payhub_post_createTransfer\" target=\"_blank\">Create Transfer</a>.","operationId":"paymenthub_post_gettransfer","requestBody":{"content":{"application/json":{"schema":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> associated with this transfer. The `direction` field in the response identifies whether this account is the source or destination of the funds. \nPattern: PRN\nExample: \"`074103447228`\""},"transferId":{"type":"string","title":"Transferid","description":"Unique identifier for the specific transfer to retrieve.\nPattern: Alphanumeric string\nExample: \"`890e4567-e89b-12d3-a456-426614174222`\""}},"type":"object","required":["accountNo","transferId","apiLogin","apiTransKey","providerId"],"title":"GetTransferRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"transferId":{"type":"string","title":"Transferid","description":"The unique identifier for the transfer."},"currencyAmount":{"description":"Response-side currency amount. Raises InternalServiceException (500) on invalid persisted data\n— bad values in response construction reflect server-side data integrity issues, not client error.","properties":{"amount":{"type":"number","examples":[199.32]},"currency":{"type":"string","title":"Currency","description":"Currency code following ISO 4217 standard.\nValidation: Exactly 3 uppercase letters.\nPattern: ^[A-Z]{3}$\nExample: 'USD' (US Dollar), 'EUR' (Euro), 'GBP' (British Pound)","default":"USD","examples":["USD"]}},"type":"object","required":["amount"],"title":"CurrencyAmountResponse"},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purpose","description":"The purpose provided for the transfer."},"remittanceInfo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remittanceinfo","description":"Additional details about the transfer, such as an invoice number."},"createdDate":{"type":"string","title":"Createddate","description":"Timestamp when the transfer was created or received."},"paymentMethod":{"description":"Payment network used for the transfer.\nPossible values:","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"},"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> associated with this view of the transfer."},"sourceAccount":{"properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/ExternalAccountDetails","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReferenceResponse","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccountResponse"}}},"destinationAccount":{"properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/ExternalAccountDetails","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReferenceResponse","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccountResponse"}}},"direction":{"description":"Direction of the transfer relative to the specified account.\n\n- IN: The specified account is the destination account of the transfer\n- OUT: The specified account is the source account of the transfer\n\nNote: Direction indicates transfer flow, but actual fund movement depends on the debit/credit indicator. For example, an incoming debit or outgoing credit may both result in funds leaving the specified account.","type":"string","enum":["IN","OUT"],"title":"Direction"},"status":{"description":"Status of the transaction.\n\n**For FedNow and FedWire transactions:**\n\n- CREATED: Initial state for transactions after creation via API call.\n- SENT: Outbound-only state indicating payment message (pacs.008 or pacs.004) successfully published to the payment network, awaiting pacs.002 status report.\n- IN PROGRESS: Transaction is being processed.\n- COMPLETED: Terminal success state. Payment network confirmed successful settlement via pacs.002 with ACSC or ACCC status.\n- FAILED: Terminal failure state. Transaction rejected by payment network or receiving FI initially.\n\n**For FedNow transactions only:**\n\n- ACCEPTED WITHOUT POST: Special intermediate state for outbound payments. Received pacs.002 with ACWP status - funds have settled but receiving Financial Institution requires additional investigation time before posting.\n- BLOCKED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Receiving FI sent pacs.002 with BLCK status - funds are blocked and will not be posted.\n- REJECTED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Received pacs.002 with RJCT status after investigation - funds must be returned via new pacs.004.\n- REQUESTED: Return has been requested (FedNow returns only).\n- REQUEST APPROVED: Return request has been approved (FedNow returns only).\n- REQUEST REJECTED: Return request has been rejected (FedNow returns only).","type":"string","enum":["CREATED","IN PROGRESS","COMPLETED","FAILED","PENDING REVIEW","SENT","ACCEPTED WITHOUT POST","BLOCKED","REJECTED","REQUESTED","REQUEST APPROVED","REQUEST REJECTED"],"title":"TransferStatus"},"statusDetails":{"type":"string","title":"Statusdetails","description":"Additional details or reasons for the current transfer status."},"railInformation":{"anyOf":[{"description":"Contains payment rail specific information","properties":{"type":{"description":"Payment network used for the transfer.","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"}},"required":["type"],"title":"RailInformationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"FEDWIRE":"#/components/schemas/FedwireRailInformation","FEDNOW":"#/components/schemas/FedNowRailInformation"}}},{"type":"null"}],"title":"Railinformation","description":"Payment rail specific information. This field is optional and can be null if not applicable."},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Externalid","description":"Client-defined identifier provided when the transfer was created."},"networkReferenceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Networkreferenceid","description":"Primary network reference for the transaction. \nFor FedWire, this field contains the UETR. \nFor FedNow, it contains either the UETR or the Transaction Identification, as indicated by the `networkReferenceIdType` in the `railInformation` field."},"paymentType":{"anyOf":[{"type":"string","enum":["RETURN","CUSTOMER CREDIT TRANSFER"],"title":"PaymentType","description":"- RETURN: Funds sent back to the originator to reverse a specific transaction\n- CUSTOMER CREDIT TRANSFER: A standard payment initiated by the customer to a third party"},{"type":"null"}],"description":"Type of payment transaction."},"returnDetails":{"anyOf":[{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Reason code describing why the transaction was returned.\nValidation:\n- FEDNOW: Required. Uses ISO 20022 External Status Reason Codes (pacs.002 StsRsnInf/Rsn/Cd). Must be 1-4 characters. Common codes include AC01 (Incorrect account number), AC03 (Invalid creditor account number), AC04 (Closed account number), AC06 (Blocked account), AC13 (Invalid debtor account type), AC14 (Invalid agent), AC15 (Account details changed), AG01 (Transaction forbidden). Refer to ISO 20022 ExternalCodeSets for the complete list of reason codes.","examples":["AC03","AC04"]},"additionalInfo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additionalinfo","description":"Optional additional context for the return.\nValidation:\n- FEDNOW: Maximum 105 characters. Maps to ISO 20022 pacs.002 StsRsnInf/AddtlInf.","examples":["Account closed by customer request"]},"originalTransactionId":{"type":"string","format":"uuid","title":"Originaltransactionid","description":"Reference to the original transaction being returned (transferId).","examples":["123e4567-e89b-12d3-a456-426614174000"]}},"type":"object","required":["originalTransactionId"],"title":"ReturnDetails","description":"Payment return information for reversing a previous transfer."},{"type":"null"}],"description":"Information about a return. Present only when `paymentType` is 'RETURN'. For FedNow, fields align to ISO 20022 pacs.002: code -> StsRsnInf/Rsn/Cd; additionalInfo -> StsRsnInf/AddtlInf."},"failureDetails":{"anyOf":[{"description":"Contains failure details with different rejection sources","properties":{"type":{"description":"Identifies where the rejection originated.","enum":["NETWORK","GALILEO"],"title":"RejectSource","type":"string"}},"required":["type"],"title":"FailureDetailsBase","type":"object","discriminator":{"propertyName":"type","mapping":{"NETWORK":"#/components/schemas/NetworkFailureDetails","GALILEO":"#/components/schemas/GalileoFailureDetails"}}},{"type":"null"}],"title":"Failuredetails","description":"Information about transaction failures including rejections from the payment network or SoFi Tech Solutions processor validation failures. For FedNow network rejections, fields align to ISO 20022 pacs.002: code -> StsRsnInf/Rsn/Cd; additionalInfo -> StsRsnInf/AddtlInf."},"sourceEntities":{"anyOf":[{"properties":{"ultimateSource":{"anyOf":[{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the entity.\n\nFedNow: Maps to ISO 20022 Nm element."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the entity.\n\nFedNow: Maps to ISO 20022 PstlAdr element."},"identification":{"anyOf":[{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},{"type":"null"}],"title":"Identification","description":"Identification details for the entity. Contains type-specific fields such as BIC and LEI for corporate entities, or other IDs for consumers.\n\nWhen absent, the entity type could not be determined (only name is known).\n\nFedNow: Maps to ISO 20022 Id element. Absent when only `Nm` is present."}},"type":"object","title":"Party","description":"Entity involved in a transfer"},{"type":"null"}],"description":"The ultimate party on whose behalf the transfer is being made. In nested or third-party scenarios, this identifies the actual individual or entity that is the source of the funds, which may differ from the account owner.\n\nFedNow: Maps to ISO 20022 UltmtDbtr (Ultimate Debtor)."},"initiatingParty":{"anyOf":[{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the entity.\n\nFedNow: Maps to ISO 20022 Nm element."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the entity.\n\nFedNow: Maps to ISO 20022 PstlAdr element."},"identification":{"anyOf":[{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},{"type":"null"}],"title":"Identification","description":"Identification details for the entity. Contains type-specific fields such as BIC and LEI for corporate entities, or other IDs for consumers.\n\nWhen absent, the entity type could not be determined (only name is known).\n\nFedNow: Maps to ISO 20022 Id element. Absent when only `Nm` is present."}},"type":"object","title":"Party","description":"Entity involved in a transfer"},{"type":"null"}],"description":"The party that initiates the transfer on behalf of the source.\n\nFedNow: Maps to ISO 20022 InitgPty (Initiating Party)."},"instructingAgent":{"anyOf":[{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification. The format depends on the clearing system specified in `clearingSystemId`.\n\nFedNow: 9-digit ABA routing number (RTN). Maps to ISO 20022 ClrSysMmbId/MmbId."},"clearingSystemId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clearingsystemid","description":"Identifies the clearing system for the member ID. Example: `USABA` for US ABA routing numbers.\n\nFedNow: Maps to ISO 20022 ClrSysId/Cd."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"Business Identifier Code (BIC) of the financial institution. 8 or 11 character SWIFT code.\n\nFedNow: Maps to ISO 20022 FinInstnId/BICFI."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier (LEI) of the financial institution. 20 character alphanumeric code.\n\nFedNow: Maps to ISO 20022 FinInstnId/LEI."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/Nm."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/PstlAdr."}},"type":"object","title":"FinancialAgent","description":"Financial institution involved in originating the transfer"},{"type":"null"}],"description":"The financial institution that sends the transfer instruction. This is typically the originating bank.\n\nFedNow: Maps to ISO 20022 InstgAgt (Instructing Agent)."}},"type":"object","title":"SourceEntities","description":"Source side entities - entities and agents involved in originating the transfer"},{"type":"null"}],"description":"Source side entities. Contains information about entities and financial institutions involved in originating the transfer, including the ultimate source of funds, initiating party, and originating financial institution.\n\nFedNow: Populated from ISO 20022 message elements."},"destinationEntities":{"anyOf":[{"properties":{"instructedAgent":{"anyOf":[{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification. The format depends on the clearing system specified in `clearingSystemId`.\n\nFedNow: 9-digit ABA routing number (RTN). Maps to ISO 20022 ClrSysMmbId/MmbId."},"clearingSystemId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clearingsystemid","description":"Identifies the clearing system for the member ID. Example: `USABA` for US ABA routing numbers.\n\nFedNow: Maps to ISO 20022 ClrSysId/Cd."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"Business Identifier Code (BIC) of the financial institution. 8 or 11 character SWIFT code.\n\nFedNow: Maps to ISO 20022 FinInstnId/BICFI."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier (LEI) of the financial institution. 20 character alphanumeric code.\n\nFedNow: Maps to ISO 20022 FinInstnId/LEI."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/Nm."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/PstlAdr."}},"type":"object","title":"FinancialAgent","description":"Financial institution involved in originating the transfer"},{"type":"null"}],"description":"The financial institution that receives the transfer instruction. This is typically the receiving/beneficiary bank.\n\nFedNow: Maps to ISO 20022 InstdAgt (Instructed Agent)."},"ultimateDestination":{"anyOf":[{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the entity.\n\nFedNow: Maps to ISO 20022 Nm element."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the entity.\n\nFedNow: Maps to ISO 20022 PstlAdr element."},"identification":{"anyOf":[{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},{"type":"null"}],"title":"Identification","description":"Identification details for the entity. Contains type-specific fields such as BIC and LEI for corporate entities, or other IDs for consumers.\n\nWhen absent, the entity type could not be determined (only name is known).\n\nFedNow: Maps to ISO 20022 Id element. Absent when only `Nm` is present."}},"type":"object","title":"Party","description":"Entity involved in a transfer"},{"type":"null"}],"description":"The ultimate party for whom the transfer is intended. In nested or third-party scenarios, this identifies the actual individual or entity that is the final recipient of the funds, which may differ from the account owner.\n\nFedNow: Maps to ISO 20022 UltmtCdtr (Ultimate Creditor)."}},"type":"object","title":"DestinationEntities","description":"Destination side entities - entities and agents involved in receiving the transfer"},{"type":"null"}],"description":"Destination side entities. Contains information about entities and financial institutions involved in receiving the transfer, including the receiving financial institution and ultimate destination of funds.\n\nFedNow: Populated from ISO 20022 message elements."}},"type":"object","required":["transferId","currencyAmount","createdDate","paymentMethod","accountNo","sourceAccount","destinationAccount","direction","status","statusDetails"],"title":"GetTransferResponse"},"examples":{"response":{"value":"{\n    \"transferId\": \"b47ac10b-58cc-4372-a567-0e02b2c3d479\",\n    \"currencyAmount\": {\n      \"amount\": 199.32,\n      \"currency\": \"USD\"\n    },\n    \"purpose\": \"Expense reimbursement\",\n    \"createdDate\": \"2025-11-11T07:19:24.485954-07:00\",\n    \"paymentMethod\": \"CARD\",\n    \"accountNo\": \"074103447228\",\n    \"sourceAccount\": {\n      \"type\": \"GALILEO\"\n    },\n    \"destinationAccount\": {\n      \"type\": \"EXTERNAL_ACCOUNT_REF\",\n      \"externalAccountLinkId\": \"0359320859384728394827182394832834\"\n    },\n    \"direction\": \"OUT\",\n    \"status\": \"COMPLETED\",\n    \"statusDetails\": \"Transfer completed successfully\",\n    \"railInformation\": null,\n    \"externalId\": \"My-Internal-ID-123\"\n}"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"401":{"description":"No valid API credentials provided.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"403":{"description":"The provided API credential does not allow this operation.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"502":{"description":"Bad Gateway.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}}},"parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)","schema":{"type":"string","pattern":"^Basic [A-Za-z0-9+/]+=*$","example":"Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5"}}]}},"/cancelTransfer":{"post":{"tags":["Transfers"],"summary":"Cancel Transfer","description":"Use the Cancel Transfer endpoint to cancel an outgoing transfer that was initiated by <a href=\"ref:payhub_post_createTransfer\" target=\"_blank\">Create Transfer</a>.\n\nTransfers must be in a `POSTED` status to be eligible for cancellation.","operationId":"paymenthub_post_canceltransfer","requestBody":{"content":{"application/json":{"schema":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> associated with the outgoing transfer to cancel."},"transferId":{"type":"string","title":"Transferid","description":"Unique identifier of the transfer to cancel.\nPattern: Alphanumeric string\nExample: `TXN-12345ABCDE`"}},"type":"object","required":["accountNo","transferId","apiLogin","apiTransKey","providerId"],"title":"CancelTransferRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"transferId":{"type":"string","title":"Transferid","description":"The unique identifier for the cancelled transfer."},"reverseAdjustmentId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reverseadjustmentid","description":"The unique identifier for the reversed adjustment transaction."}},"type":"object","required":["transferId","reverseAdjustmentId"],"title":"CancelTransferResponse"},"examples":{"response":{"value":"{\n    \"transferId\": \"890e4567-e89b-12d3-a456-426614174222\",\n    \"reverseAdjustmentId\": \"rev-adj-987654321\"\n}"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"401":{"description":"No valid API credentials provided.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"403":{"description":"The provided API credential does not allow this operation.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"502":{"description":"Bad Gateway.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}}},"parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)","schema":{"type":"string","pattern":"^Basic [A-Za-z0-9+/]+=*$","example":"Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5"}}]}},"/createExternalAccountLink":{"post":{"tags":["External Account Links"],"summary":"Create External Account Link","description":"> 👍 Availability\n>\n>Some of the field descriptions for this endpoint reference FedNow or Fedwire, which are future capabilities not yet available for clients. Right now, this endpoint supports only Mastercard Data Connect: Account Linking and Mastercard Data Connect: Balance Check.\n\nUse the Create External Account Link endpoint to create a link from an account at an external bank to the caller account when a user manually inputs their external account information. This account will be usable for transfers over FedWire or credit rails, depending on your configuration.","operationId":"paymenthub_post_createexternalaccountlink","parameters":[{"name":"x-gft-idempotency-key","in":"header","required":true,"schema":{"type":"string","format":"uuid4","title":"X-Gft-Idempotency-Key"}},{"name":"Authorization","in":"header","required":true,"description":"Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)","schema":{"type":"string","pattern":"^Basic [A-Za-z0-9+/]+=*$","example":"Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> of the account.\nPattern: PRN \nExample: `\"074103447228\"`","examples":["074103447228"]},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","description":"Display name for the remote account. Not considered to be sensitive data.\nPattern: 1–34 characters with at least one non-whitespace character.\nExample: `\"Celia College Fund\"`","examples":["Celia College Fund","dest name 1"]},"owner":{"description":"Owner information for the external account.","properties":{"type":{"description":"Type of entity that owns the external account.\nExample: `\"CONSUMER\"`","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"default":"FIRST_PARTY","description":"Relationship of the account owner to the program account.\nExample: `\"FIRST_PARTY\"`","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type"],"title":"AccountOwnerBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwner","CORPORATE":"#/components/schemas/CorporateAccountOwner","GALILEO":"#/components/schemas/GalileoAccountOwner"}}},"details":{"description":"Card or bank details for the external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseRequest","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetails","CARD":"#/components/schemas/CardAccountDetails"}}},"validation":{"description":"Details for validating the external account link.","properties":{"type":{"description":"Specifies the validation method required for the external account link.\nPattern: enum\nExample: `\"CLIENT\"`","default":"CLIENT","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Indicates the current status of the validation process.\nPattern: enum\nExample: `\"PENDING\"`","default":"PENDING","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Reason","description":"Provides additional context or a reason for the current validation status.\nPattern: Alphanumeric string\nExample: `\"Validated successfully\"`"}},"type":"object","title":"ExternalAccountLinkValidation"}},"type":"object","required":["accountNo","owner","details","validation","apiLogin","apiTransKey","providerId"],"title":"CreateExternalAccountLinkRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."}},"type":"object","required":["externalAccountLinkId"],"title":"CreateExternalAccountLinkResponse"},"examples":{"response":{"value":"{\n    \"externalAccountLinkId\": \"123e4567-e89b-12d3-a456-4266100532\"\n}"}}}}},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"No valid API credentials provided.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"403":{"description":"The provided API credential does not allow this operation.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}},"description":"Conflict"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}},"description":"Internal Server Error"},"502":{"description":"Bad Gateway.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}}}}},"/loadExternalAccountLinks":{"post":{"tags":["External Account Links"],"summary":"Load External Account Links","description":"Use the Load External Account Links endpoint to initiate a link between external account(s) and the caller account when a user inputs their external account credentials during a secure session in your application. The external account will be usable for transfers over FedWire or credit rails, depending on your configuration.","operationId":"paymenthub_post_loadexternalaccountlinks","parameters":[{"name":"x-gft-idempotency-key","in":"header","required":true,"schema":{"type":"string","format":"uuid4","title":"X-Gft-Idempotency-Key"}},{"name":"Authorization","in":"header","required":true,"description":"Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)","schema":{"type":"string","pattern":"^Basic [A-Za-z0-9+/]+=*$","example":"Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> to which the new external account will be linked.\nPattern: PRN\nExample: `\"074103447228\"`","examples":["074103447228"]},"integration":{"description":"Contains the account and customer identifiers from the specified third-party provider.","properties":{"type":{"description":"Third-party provider used to link the account.\nExample: FINICITY","type":"string","enum":["FINICITY"],"title":"IntegrationType"},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customerid","description":"Unique customer identifier provided by the integration partner.\nPattern: Alphanumeric string\nExample: `\"1005061234\"`","examples":["1005061234"]},"accountId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accountid","description":"Unique account identifier provided by the integration partner.\nPattern: Alphanumeric string\nExample: `\"5011648377\"`","examples":["5011648377"]}},"type":"object","required":["type"],"title":"FinicityIntegration"},"validation":{"anyOf":[{"properties":{"type":{"description":"Specifies the validation method required for the external account link.\nPattern: enum\nExample: `\"CLIENT\"`","default":"CLIENT","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Indicates the current status of the validation process.\nPattern: enum\nExample: `\"PENDING\"`","default":"PENDING","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Reason","description":"Provides additional context or a reason for the current validation status.\nPattern: Alphanumeric string\nExample: `\"Validated successfully\"`"}},"type":"object","title":"ExternalAccountLinkValidation"},{"type":"null"}]}},"type":"object","required":["accountNo","integration","apiLogin","apiTransKey","providerId"],"title":"LoadExternalAccountLinksRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."},"status":{"type":"string","title":"Status","description":"Status of the external account link.","default":"PENDING"},"integration":{"description":"Contains information about the third-party provider.","properties":{"type":{"description":"Third-party provider such as FINICITY, PLAID, etc","type":"string","enum":["FINICITY"],"title":"IntegrationType"},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customerid","description":"The customer ID of the account.","examples":["1005061234"]},"accountId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accountid","description":"The account ID of the account.","examples":["5011648377"]},"institutionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Institutionid","description":"The institution ID of the account.","examples":["102105"]}},"type":"object","required":["type"],"title":"LoadApiIntegration"}},"type":"object","required":["externalAccountLinkId","integration"],"title":"LoadExternalAccountLinksResponse"},"title":"Response 200 Load External Account Links Call Loadexternalaccountlinks Post"},"examples":{"response":{"value":"[\n    {\n      \"externalAccountLinkId\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"status\": \"PENDING\",\n      \"integration\": {\n        \"type\": \"FINICITY\",\n        \"customerId\": \"1005061234\",\n        \"accountId\": \"5011648377\",\n        \"institutionId\": \"102105\"\n      }\n    }\n]"}}}}},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}},"description":"Bad Request"},"401":{"description":"No valid API credentials provided.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"403":{"description":"The provided API credential does not allow this operation.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}},"description":"Conflict"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}},"description":"Internal Server Error"},"502":{"description":"Bad Gateway.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}}}}},"/modifyExternalAccountLink":{"post":{"tags":["External Account Links"],"summary":"Modify External Account Link","description":"Use the Modify External Account Link endpoint to update an existing external bank account that sends and receives transactions.\n\nSpecify only the parameter(s) you wish to modify. Do not pass parameters with `null` or empty values.","operationId":"paymenthub_post_modifyexternalaccountlink","requestBody":{"content":{"application/json":{"schema":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> to which the external account is linked.\nPattern: PRN\nExample: `\"074103447228\"`","examples":["074103447228"]},"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier for the specific external account link to modify.\nPattern: 1–40 digits\nExample: `\"0359320859384728394827182394832834\"`","examples":["0359320859384728394827182394832834"]},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","description":"Display name for the remote account. Not considered to be sensitive data.\nPattern: 1–34 characters\nExample: `\"My Savings Account\"`","examples":["Celia College Fund","dest name 1"]},"owner":{"anyOf":[{"properties":{"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Primary address for the account owner."},"consumerFirstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumerfirstname","description":"First name of the individual who owns the account.\nPattern: 1-40 characters\nExample: `\"Jane\"`","examples":["John"]},"consumerLastName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumerlastname","description":"Last name of the individual who owns the account.\nPattern: 1-40 characters\nExample: `\"Doe\"`","examples":["Smith"]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Businessname","description":"Legal name of the business that owns the account.\nPattern: 1-40 characters\nExample: `\"ABC Corporation\"`","examples":["ABC Corp"]}},"type":"object","title":"ModifiableExternalAccountOwner"},{"type":"null"}],"description":"Specifies the owner-related fields to update.","default":{}},"details":{"anyOf":[{"description":"Base class for modifiable account details","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"ModifiableAccountDetailsBase","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/ModifiableExternalBankAccountDetails","CARD":"#/components/schemas/ModifiableExternalCardAccountDetails"}}},{"type":"null"}],"title":"Details","description":"Specifies the account or card details to update."},"validation":{"anyOf":[{"properties":{"type":{"anyOf":[{"type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},{"type":"null"}],"description":"Validation method for the external account.\nExample: CLIENT"},"status":{"anyOf":[{"type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},{"type":"null"}],"description":"Validation status of the external account.\nExample: VERIFIED"}},"type":"object","title":"ModifiableExternalAccountLinkValidation"},{"type":"null"}],"description":"Specifies the validation information to update.","default":{}}},"type":"object","required":["accountNo","externalAccountLinkId","apiLogin","apiTransKey","providerId"],"title":"ModifyExternalAccountLinkRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."}},"type":"object","required":["externalAccountLinkId"],"title":"ModifyExternalAccountLinkResponse"},"examples":{"response":{"value":"{\n    \"externalAccountLinkId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"401":{"description":"No valid API credentials provided.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"403":{"description":"The provided API credential does not allow this operation.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"502":{"description":"Bad Gateway.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}}},"parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)","schema":{"type":"string","pattern":"^Basic [A-Za-z0-9+/]+=*$","example":"Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5"}}]}},"/getExternalAccountLink":{"post":{"tags":["External Account Links"],"summary":"Get External Account Link","description":"> 👍 Availability\n>\n>Some of the field descriptions for this endpoint reference FedNow or Fedwire, which are future capabilities not yet available for clients. Right now, this endpoint supports only Mastercard Data Connect: Account Linking and Mastercard Data Connect: Balance Check.\n\nUse the Get External Account Link endpoint to retrieve a remote account that was created by <a href=\"ref:paymenthub_post_createexternalaccountlink\" target=\"_blank\">Create External Account Link</a> for the specified `accountNo`.","operationId":"paymenthub_post_getexternalaccountlink","requestBody":{"content":{"application/json":{"schema":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> to which the external account is linked.\nPattern: PRN\nExample: `\"074103447228\"`","examples":["074103447228"]},"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier for the specific external account link to retrieve.\nExample: `\"0359320859384728394827182394832834\"`","examples":["0359320859384728394827182394832834"]},"includeBalance":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Includebalance","description":"Specifies whether to include the external account's live balance in the response.\nExample: `true`","default":false,"examples":[true]}},"type":"object","required":["accountNo","externalAccountLinkId","apiLogin","apiTransKey","providerId"],"title":"GetExternalAccountLinkRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","DELETED","PENDING","FAILED"],"title":"ExternalAccountLinkStatus"},{"type":"null"}],"description":"Status of the external account link."},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","description":"Display name for the remote account. Not considered to be sensitive data. \nPattern: Max 34 alphanumeric, punctuation\nExample: `\"Celia College Fund\"`","examples":["Celia College Fund","dest name 1"]},"owner":{"description":"Owner information for the linked external account.","properties":{"type":{"description":"Type of account owner:","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"description":"Relationship of the account owner to the program account.","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type","ownershipType"],"title":"AccountOwnerResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwnerResponse","CORPORATE":"#/components/schemas/CorporateAccountOwnerResponse","GALILEO":"#/components/schemas/GalileoAccountOwnerResponse"}}},"details":{"description":"Card or bank details for the linked external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseResponse","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetailsResponse","CARD":"#/components/schemas/CardAccountDetailsResponse"}}},"validation":{"description":"Validation details for the linked external account.","properties":{"type":{"description":"Type of validation:","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Status of the validation:","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason for the validation status.","title":"Status Reason"}},"required":["type","status"],"title":"ValidationResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/ExternalAccountLinkCardValidationResponse","FINICITY":"#/components/schemas/ExternalAccountLinkFinicityValidationResponse","CLIENT":"#/components/schemas/ExternalAccountLinkClientValidationResponse","LEGACY":"#/components/schemas/ExternalAccountLinkLegacyValidationResponse","MICRO_ENTRY":"#/components/schemas/ExternalAccountLinkMicroEntryValidationResponse","NONE":"#/components/schemas/ExternalAccountLinkNoValidationResponse"}}}},"type":"object","required":["externalAccountLinkId","owner","details","validation"],"title":"GetExternalAccountLinkResponse"},"examples":{"response":{"value":"{\n    \"externalAccountLinkId\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"status\": \"ACTIVE\",\n    \"nickname\": \"Celia College Fund\",\n    \"owner\": {\n      \"type\": \"CORPORATE\",\n      \"ownershipType\": \"FIRST_PARTY\",\n      \"address\": null\n    },\n    \"details\": {\n      \"type\": \"BANK\"\n    },\n    \"validation\": {\n      \"type\": \"CLIENT\",\n      \"status\": \"PENDING\",\n      \"status_reason\": null\n    }\n}"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"401":{"description":"No valid API credentials provided.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"403":{"description":"The provided API credential does not allow this operation.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"502":{"description":"Bad Gateway.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}}},"parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)","schema":{"type":"string","pattern":"^Basic [A-Za-z0-9+/]+=*$","example":"Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5"}}]}},"/listExternalAccountLinks":{"post":{"tags":["External Account Links"],"summary":"List External Account Links","description":"Use the List External Account Links endpoint to retrieve a list of remote accounts that were created by <a href=\"ref:paymenthub_post_createexternalaccountlink\" target=\"_blank\">Create External Account Link</a> for the specified `accountNo`.","operationId":"paymenthub_post_listexternalaccountlinks","requestBody":{"content":{"application/json":{"schema":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"All external account links associated with this <<glossary:PRN>>.\nPattern: PRN\nExample: `\"074103447228\"`","examples":["074103447228"]},"limit":{"type":"integer","title":"Limit","description":"Maximum number of account links to return in the response.\nPattern: Integer, max 15\nExample: `15`","examples":[1,12,15]},"page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page","description":"Pass the `nextPage` token from a previous response to fetch the subsequent page.\nPattern: Alphanumeric token\nExample: `\"NO34BNT04TV234N6V274692376G32NNFNNF7988247923865017061N\"`","examples":["NO34BNT04TV234N6V274692376G32NNFNNF7988247923865017061N"]}},"type":"object","required":["accountNo","apiLogin","apiTransKey","providerId"],"title":"ListExternalAccountLinksRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"externalAccountLinks":{"anyOf":[{"items":{"properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","DELETED","PENDING","FAILED"],"title":"ExternalAccountLinkStatus"},{"type":"null"}],"description":"Status of the external account link."},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","description":"Display name for the remote account. Not considered to be sensitive data. \nPattern: Max 34 alphanumeric, punctuation\nExample: `\"Celia College Fund\"`","examples":["Celia College Fund","dest name 1"]},"owner":{"description":"Owner information for the linked external account.","properties":{"type":{"description":"Type of account owner:","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"description":"Relationship of the account owner to the program account.","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type","ownershipType"],"title":"AccountOwnerResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwnerResponse","CORPORATE":"#/components/schemas/CorporateAccountOwnerResponse","GALILEO":"#/components/schemas/GalileoAccountOwnerResponse"}}},"details":{"description":"Card or bank details for the linked external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseResponse","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetailsResponse","CARD":"#/components/schemas/CardAccountDetailsResponse"}}},"validation":{"description":"Validation details for the linked external account.","properties":{"type":{"description":"Type of validation:","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Status of the validation:","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason for the validation status.","title":"Status Reason"}},"required":["type","status"],"title":"ValidationResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/ExternalAccountLinkCardValidationResponse","FINICITY":"#/components/schemas/ExternalAccountLinkFinicityValidationResponse","CLIENT":"#/components/schemas/ExternalAccountLinkClientValidationResponse","LEGACY":"#/components/schemas/ExternalAccountLinkLegacyValidationResponse","MICRO_ENTRY":"#/components/schemas/ExternalAccountLinkMicroEntryValidationResponse","NONE":"#/components/schemas/ExternalAccountLinkNoValidationResponse"}}}},"type":"object","required":["externalAccountLinkId","owner","details","validation"],"title":"GetExternalAccountLinkResponse"},"type":"array"},{"type":"null"}],"title":"Externalaccountlinks","description":"List of External Account Links."},"nextPage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nextpage","description":"Token to use to retrieve the next page. If this field is missing, there are no more pages to return."}},"type":"object","required":["externalAccountLinks"],"title":"ListExternalAccountLinksResponse"},"examples":{"response":{"value":"{\n    \"externalAccountLinks\": [\n      {\n        \"externalAccountLinkId\": \"550e8400-e29b-41d4-a716-446655440000\",\n        \"status\": \"ACTIVE\",\n        \"nickname\": \"Celia College Fund\",\n        \"owner\": {\n          \"type\": \"CORPORATE\",\n          \"ownershipType\": \"FIRST_PARTY\",\n          \"address\": null\n        },\n        \"details\": {\n          \"type\": \"BANK\"\n        },\n        \"validation\": {\n          \"type\": \"CLIENT\",\n          \"status\": \"PENDING\",\n          \"status_reason\": null\n        }\n      }\n    ],\n    \"nextPage\": \"123e4567-e89b-12d3-a456-4266100532\"\n}"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"401":{"description":"No valid API credentials provided.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"403":{"description":"The provided API credential does not allow this operation.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"502":{"description":"Bad Gateway.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}}},"parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)","schema":{"type":"string","pattern":"^Basic [A-Za-z0-9+/]+=*$","example":"Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5"}}]}},"/removeExternalAccountLink":{"post":{"tags":["External Account Links"],"summary":"Remove External Account Links","description":"Use the Remove External Account Link endpoint to remove a link to an account created by <a href=\"ref:paymenthub_post_createexternalaccountlink\" target=\"_blank\">Create External Account Link</a>.","operationId":"paymenthub_post_removeexternalaccountlink","requestBody":{"content":{"application/json":{"schema":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> from which to remove the external account link.\nPattern: PRN\nExample: `\"074103447228\"`","examples":["074103447228"]},"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier for the specific external account link to remove.\nPattern: 1–40 digits\nExample: `\"0359320859384728394827182394832834\"`","examples":["0359320859384728394827182394832834"]}},"type":"object","required":["accountNo","externalAccountLinkId","apiLogin","apiTransKey","providerId"],"title":"RemoveExternalAccountLinkRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."}},"type":"object","required":["externalAccountLinkId"],"title":"RemoveExternalAccountLinkResponse"},"examples":{"response":{"value":"{\n    \"externalAccountLinkId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"401":{"description":"No valid API credentials provided.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"403":{"description":"The provided API credential does not allow this operation.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"502":{"description":"Bad Gateway.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}}},"parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)","schema":{"type":"string","pattern":"^Basic [A-Za-z0-9+/]+=*$","example":"Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5"}}]}},"/getExternalAccountLinkAccess":{"post":{"tags":["External Account Links"],"summary":"Get External Account Link Access","description":"Use the Get External Account Link Access endpoint to initiate a secure, user-facing session for linking an external account. This endpoint generates a temporary link for the user to securely provide their credentials to a third-party partner like Finicity.","operationId":"paymenthub_post_getexternalaccountlinkaccess","requestBody":{"content":{"application/json":{"schema":{"properties":{"accountNo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accountno","description":"The <<glossary:PRN>> for which to generate the secure linking session.\nRequired for GALILEO_CARD_CAPTURE integration.\nPattern: PRN\nExample: 074103447228","examples":["074103447228"]},"integration":{"description":"Third-party partner to use for the secure account-linking session.\nExample: FINICITY","type":"string","enum":["FINICITY","GALILEO_CARD_CAPTURE"],"title":"AccessIntegration"}},"type":"object","required":["integration","apiLogin","apiTransKey","providerId"],"title":"GetExternalAccountLinkAccessRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"token":{"properties":{"type":{"description":"Type of token returned.\nExample: JWT","examples":["JWT","FINICITY_TOKEN"],"type":"string","enum":["JWT","FINICITY_TOKEN"],"title":"AccessTokenType"},"value":{"type":"string","title":"Value","description":"Token used to authenticate the secure session.\nFor JWT: JSON Web Token for GALILEO_CARD_CAPTURE integration.\nFor FINICITY_TOKEN: Finicity application token for API authentication.\nPattern: Token string\nExample: fqnu103294.g4234g234f.42g2345gteg","examples":["fqnu103294.g4234g234f.42g2345gteg"]},"appKey":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Appkey","description":"Application key for API authentication.\nOnly provided for FINICITY integration.\nPattern: Alphanumeric string\nExample: abc123def456","examples":["abc123def456"]}},"type":"object","required":["type","value"],"title":"TokenDetails"},"expirationTimestamp":{"type":"string","title":"Expirationtimestamp","description":"ISO 8601 timestamp when the access token expires.\nPattern: ISO 8601 format\nExample: `\"2025-06-11T09:49:20.055367-06:00\"`","examples":["2025-06-11T09:49:20.055367-06:00"]},"expirationDate":{"type":"string","title":"Expirationdate","description":"Deprecated: Use expirationTimestamp instead. ISO 8601 timestamp when the access token expires.\nPattern: ISO 8601 format\nExample: `\"2025-06-11T09:49:20.055367-06:00\"`","deprecated":true,"examples":["2025-06-11T09:49:20.055367-06:00"]}},"type":"object","required":["token","expirationTimestamp","expirationDate"],"title":"GetExternalAccountLinkAccessResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"401":{"description":"No valid API credentials provided.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"403":{"description":"The provided API credential does not allow this operation.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"502":{"description":"Bad Gateway.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"}}}}},"parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)","schema":{"type":"string","pattern":"^Basic [A-Za-z0-9+/]+=*$","example":"Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5"}}]}}},"components":{"schemas":{"AccessIntegration":{"type":"string","enum":["FINICITY","GALILEO_CARD_CAPTURE"],"title":"AccessIntegration"},"AccessTokenType":{"type":"string","enum":["JWT","FINICITY_TOKEN"],"title":"AccessTokenType"},"AccountIdentification":{"properties":{"number":{"type":"string","title":"Number","description":"Account number or IBAN."},"type":{"description":"Type of account number.\n- IBAN: International Bank Account Number, validated per ISO 13616\n- ACCOUNT_NUMBER: Standard account identifier (default when omitted)","default":"ACCOUNT_NUMBER","type":"string","enum":["IBAN","ACCOUNT_NUMBER"],"title":"AccountNumberType"}},"type":"object","required":["number"],"title":"AccountIdentification","description":"Account identification — account number or IBAN."},"AccountNumberType":{"type":"string","enum":["IBAN","ACCOUNT_NUMBER"],"title":"AccountNumberType"},"AccountRequest":{"allOf":[{"description":"Identifies the account's role in the transaction.\n\nIf used as the **sourceAccount**, this is the account being debited. For push transfers (withdrawals), use the\nSoFi Tech Solutions account; for pull transfers (deposits), use the linked external account.\n\nIf used as the **destinationAccount**, this is the account being credited. For push transfers, use the linked\nexternal account; for pull transfers, use the SoFi Tech Solutions account.","properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/AccountRequest","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReference","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccount"}}},{"type":"object","properties":{"external_account_link_model":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> of the account.\nPattern: PRN \nExample: `\"074103447228\"`","examples":["074103447228"]},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","description":"Display name for the remote account. Not considered to be sensitive data.\nPattern: 1–34 characters with at least one non-whitespace character.\nExample: `\"Celia College Fund\"`","examples":["Celia College Fund","dest name 1"]},"owner":{"description":"Owner information for the external account.","properties":{"type":{"description":"Type of entity that owns the external account.\nExample: `\"CONSUMER\"`","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"default":"FIRST_PARTY","description":"Relationship of the account owner to the program account.\nExample: `\"FIRST_PARTY\"`","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type"],"title":"AccountOwnerBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwner","CORPORATE":"#/components/schemas/CorporateAccountOwner","GALILEO":"#/components/schemas/GalileoAccountOwner"}}},"details":{"description":"Card or bank details for the external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseRequest","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetails","CARD":"#/components/schemas/CardAccountDetails"}}},"validation":{"description":"Details for validating the external account link.","properties":{"type":{"description":"Specifies the validation method required for the external account link.\nPattern: enum\nExample: `\"CLIENT\"`","default":"CLIENT","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Indicates the current status of the validation process.\nPattern: enum\nExample: `\"PENDING\"`","default":"PENDING","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Reason","description":"Provides additional context or a reason for the current validation status.\nPattern: Alphanumeric string\nExample: `\"Validated successfully\"`"}},"type":"object","title":"ExternalAccountLinkValidation"}},"type":"object","required":["accountNo","owner","details","validation"],"title":"CreateExternalAccountLinkRequest"},"storeAccount":{"type":"boolean","title":"Storeaccount","description":"Specifies whether to save the new external account details for future use.\nExample: true","default":false}},"required":["external_account_link_model"],"x-discriminator-default-value":"EXTERNAL_ACCOUNT_LINK_REQUEST"}]},"ApiIntegration":{"properties":{"type":{"description":"Third-party provider such as FINICITY, PLAID, etc","type":"string","enum":["FINICITY"],"title":"IntegrationType"},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customerid","description":"The customer ID of the account.","examples":["1005061234"]},"accountId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accountid","description":"The account ID of the account.","examples":["5011648377"]},"institutionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Institutionid","description":"The institution ID of the account.","examples":["102105"]},"balance":{"anyOf":[{"properties":{"amount":{"type":"number","examples":[199.32]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","default":"USD","examples":["USD"]},"status":{"anyOf":[{"type":"string","enum":["NOT AVAILABLE","TIMED OUT"],"title":"BalanceStatus"},{"type":"null"}],"examples":["NOT AVAILABLE"]}},"type":"object","title":"CurrencyAmountStatus"},{"type":"null"}],"description":"The live balance of the account, if available. Only available for third-party integrations."}},"type":"object","required":["type"],"title":"ApiIntegration"},"BalanceStatus":{"type":"string","enum":["NOT AVAILABLE","TIMED OUT"],"title":"BalanceStatus"},"BankAccountDetails":{"allOf":[{"description":"Card or bank details for the external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseRequest","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetails","CARD":"#/components/schemas/CardAccountDetails"}}},{"type":"object","properties":{"bankDepositType":{"type":"string","enum":["CHECKING","SAVINGS","MONEY_MARKET","CMA"],"title":"BankDepositType"},"bankAddress":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}]},"bankAccountNumber":{"type":"string","title":"Bankaccountnumber","description":"Full account number for the external bank account.\nAccepts both domestic account numbers and IBANs. When providing an IBAN, set `bankAccountNumberType` to `IBAN`.\nPattern: Alphanumeric string\nExample: `\"324839572834\"` or `\"DE89370400440532013000\"` (IBAN)","examples":["324839572834","DE89370400440532013000"]},"bankAccountNumberType":{"description":"Type of account number provided in bankAccountNumber.\n- IBAN: International Bank Account Number, validated per ISO 13616\n- ACCOUNT_NUMBER: Standard account identifier (default when omitted)","default":"ACCOUNT_NUMBER","type":"string","enum":["IBAN","ACCOUNT_NUMBER"],"title":"AccountNumberType"},"bankRoutingInfo":{"items":{"properties":{"type":{"description":"Type of routing information provided.\nValues: ROUTING_NO, BIC\n- ROUTING_NO: ABA/RTN routing number\n- BIC: SWIFT/BIC code\nExample: `ROUTING_NO`","type":"string","enum":["ROUTING_NO","BIC"],"title":"RoutingInfoType"},"paymentType":{"description":"Payment rail that will use this routing information.\nExample: FEDWIRE","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"},"value":{"type":"string","title":"Value","description":"Routing identifier value.\n- For ROUTING_NO: 9-digit ABA routing number. Example: `\"124001234\"`\n- For BIC: 8 or 11-character SWIFT/BIC code. Example: `\"CHASUS33\"`, `\"NWBKGB2LXXX\"`"}},"type":"object","required":["type","paymentType","value"],"title":"RoutingInfo"},"type":"array","title":"Bankroutinginfo","description":"Routing path for the external account. Supports routing numbers (ABA/RTN) and BIC/SWIFT codes.\nPattern: At least one routing path is required."},"bankName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bankname","description":"Name of the financial institution for the external account.\nPattern:\n- Default: 1–40 characters with at least one non-whitespace character\n- FEDNOW: 1–140 characters\n- FEDWIRE: 1–140 characters, limited to alphanumeric and special characters.\nExample: `\"AbcBank\"`","examples":["AbcBank"]}},"required":["bankDepositType","bankAccountNumber","bankRoutingInfo"],"x-discriminator-default-value":"BANK"}]},"BankAccountDetailsResponse":{"allOf":[{"description":"Card or bank details for the linked external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseResponse","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetailsResponse","CARD":"#/components/schemas/CardAccountDetailsResponse"}}},{"type":"object","properties":{"bankDepositType":{"anyOf":[{"type":"string","enum":["CHECKING","SAVINGS","MONEY_MARKET","CMA"],"title":"BankDepositType"},{"type":"null"}]},"bankAddress":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}]},"bankAccountNumber":{"type":"string","title":"Bankaccountnumber","description":"bank account number.","examples":["324839572834"]},"bankAccountNumberSuffix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bankaccountnumbersuffix","description":"Contains the real account number trailing digits. If an FI (e.g., Chase) returns a tokenized account number in `bankAccountNumber`, that value may have different trailing digits. Use `bankAccountNumberSuffix` to display the true suffix","examples":["2834"]},"bankRoutingInfo":{"items":{"properties":{"type":{"description":"Type of routing information provided.\nValues: ROUTING_NO, BIC\n- ROUTING_NO: ABA/RTN routing number\n- BIC: SWIFT/BIC code\nExample: `ROUTING_NO`","type":"string","enum":["ROUTING_NO","BIC"],"title":"RoutingInfoType"},"paymentType":{"description":"Payment rail that will use this routing information.\nExample: FEDWIRE","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"},"value":{"type":"string","title":"Value","description":"Routing identifier value.\n- For ROUTING_NO: 9-digit ABA routing number. Example: `\"124001234\"`\n- For BIC: 8 or 11-character SWIFT/BIC code. Example: `\"CHASUS33\"`, `\"NWBKGB2LXXX\"`"}},"type":"object","required":["type","paymentType","value"],"title":"RoutingInfo"},"type":"array","title":"Bankroutinginfo","description":"Routing paths to the external account"},"bankName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bankname","description":"Name of the bank.","examples":["AbcBank"]},"integration":{"anyOf":[{"properties":{"type":{"description":"Third-party provider such as FINICITY, PLAID, etc","type":"string","enum":["FINICITY"],"title":"IntegrationType"},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customerid","description":"The customer ID of the account.","examples":["1005061234"]},"accountId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accountid","description":"The account ID of the account.","examples":["5011648377"]},"institutionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Institutionid","description":"The institution ID of the account.","examples":["102105"]},"balance":{"anyOf":[{"properties":{"amount":{"type":"number","examples":[199.32]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","default":"USD","examples":["USD"]},"status":{"anyOf":[{"type":"string","enum":["NOT AVAILABLE","TIMED OUT"],"title":"BalanceStatus"},{"type":"null"}],"examples":["NOT AVAILABLE"]}},"type":"object","title":"CurrencyAmountStatus"},{"type":"null"}],"description":"The live balance of the account, if available. Only available for third-party integrations."}},"type":"object","required":["type"],"title":"ApiIntegration"},{"type":"null"}],"description":" << integration >> "}},"required":["bankAccountNumber","bankRoutingInfo"],"x-discriminator-default-value":"BANK"}]},"BankDepositType":{"type":"string","enum":["CHECKING","SAVINGS","MONEY_MARKET","CMA"],"title":"BankDepositType"},"CancelTransferRequest":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> associated with the outgoing transfer to cancel."},"transferId":{"type":"string","title":"Transferid","description":"Unique identifier of the transfer to cancel.\nPattern: Alphanumeric string\nExample: `TXN-12345ABCDE`"}},"type":"object","required":["accountNo","transferId"],"title":"CancelTransferRequest"},"CancelTransferResponse":{"properties":{"transferId":{"type":"string","title":"Transferid","description":"The unique identifier for the cancelled transfer."},"reverseAdjustmentId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reverseadjustmentid","description":"The unique identifier for the reversed adjustment transaction."}},"type":"object","required":["transferId","reverseAdjustmentId"],"title":"CancelTransferResponse"},"CardAccountDetails":{"allOf":[{"description":"Card or bank details for the external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseRequest","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetails","CARD":"#/components/schemas/CardAccountDetails"}}},{"type":"object","properties":{"cardNumber":{"type":"string","title":"Cardnumber","description":"Full card number of the external debit or credit card.\nPattern: 15–16 digits\nExample: 4111111111111111"},"cardUseOwnerAddress":{"type":"boolean","title":"Carduseowneraddress","description":"Specifies whether to use the account owner's address on file for the card.\nPattern: true or false\nExample: true"},"cardAddress":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Billing address for the card if different from the owner's address. Should not be provided when `cardUseOwnerAddress` is `true`. Required when `cardUseOwnerAddress` is `false`.\nPattern: true or false\n"},"cardCvv":{"type":"string","title":"Cardcvv","description":"The <<glossary:CVV>> for the external card.\nPattern: 3–4 digits\nExample: `123` (for most cards), `1234` (for Amex)","examples":["123","1234"]},"cardExpirationDate":{"type":"string","title":"Cardexpirationdate","description":"Expiration date of the external card. Must be a valid month (01–12) and year from 2025 to 2099.\nPattern: `YYYY-MM`\nExample: `2028-12`","examples":["2025-01","2025-12"]}},"required":["cardNumber","cardUseOwnerAddress","cardCvv","cardExpirationDate"],"x-discriminator-default-value":"CARD"}]},"CardAccountDetailsResponse":{"allOf":[{"description":"Card or bank details for the linked external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseResponse","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetailsResponse","CARD":"#/components/schemas/CardAccountDetailsResponse"}}},{"type":"object","properties":{"cardType":{"anyOf":[{"type":"string","enum":["DEBIT","CREDIT","PREPAID","CHARGE_CARD","DEFERRED_DEBIT"],"title":"CardType"},{"type":"null"}],"description":"Type of the card, such as DEBIT or CREDIT."},"cardNumber":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardnumber","description":"Card number.","examples":["123412341234"]},"cardExpirationDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardexpirationdate","description":"Card expiration date.","examples":["2025-12"]},"cardAddress":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Address associated with the card."},"cardUseOwnerAddress":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Carduseowneraddress","description":"Indicates whether to use the owner's address for the card."},"cardNetworkDetails":{"items":{"properties":{"issuerName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuername","description":"Name of the Card Issuer."},"cardNetwork":{"anyOf":[{"type":"string","enum":["VISA","ACCEL_EXCHANGE","CU24","INTERLINK","MAESTRO","NYCE","PULSE","STAR"],"title":"CardNetwork"},{"type":"null"}],"description":"Card network, such as VISA or MASTERCARD."},"octCrossBorder":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Octcrossborder","description":"Indicates if the card is allowed for cross-border OCT transactions."},"aftCrossBorder":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Aftcrossborder","description":"Indicates if the card is allowed for cross-border AFT transactions."},"octDomestic":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Octdomestic","description":"Indicates if the card is allowed for domestic OCT transactions."},"aftDomestic":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Aftdomestic","description":"Indicates if the card is allowed for domestic AFT transactions."}},"type":"object","title":"CardNetworkDetails"},"type":"array","title":"Cardnetworkdetails","description":"Details about the card network.","default":[]}},"required":["cardNumber","cardExpirationDate"],"x-discriminator-default-value":"CARD"}]},"CardNetwork":{"type":"string","enum":["VISA","ACCEL_EXCHANGE","CU24","INTERLINK","MAESTRO","NYCE","PULSE","STAR"],"title":"CardNetwork"},"CardNetworkDetails":{"properties":{"issuerName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuername","description":"Name of the Card Issuer."},"cardNetwork":{"anyOf":[{"type":"string","enum":["VISA","ACCEL_EXCHANGE","CU24","INTERLINK","MAESTRO","NYCE","PULSE","STAR"],"title":"CardNetwork"},{"type":"null"}],"description":"Card network, such as VISA or MASTERCARD."},"octCrossBorder":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Octcrossborder","description":"Indicates if the card is allowed for cross-border OCT transactions."},"aftCrossBorder":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Aftcrossborder","description":"Indicates if the card is allowed for cross-border AFT transactions."},"octDomestic":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Octdomestic","description":"Indicates if the card is allowed for domestic OCT transactions."},"aftDomestic":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Aftdomestic","description":"Indicates if the card is allowed for domestic AFT transactions."}},"type":"object","title":"CardNetworkDetails"},"CardType":{"type":"string","enum":["DEBIT","CREDIT","PREPAID","CHARGE_CARD","DEFERRED_DEBIT"],"title":"CardType"},"ClearingSystemId":{"type":"string","enum":["USABA"],"title":"ClearingSystemId"},"ConsumerAccountOwner":{"allOf":[{"description":"Owner information for the external account.","properties":{"type":{"description":"Type of entity that owns the external account.\nExample: `\"CONSUMER\"`","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"default":"FIRST_PARTY","description":"Relationship of the account owner to the program account.\nExample: `\"FIRST_PARTY\"`","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type"],"title":"AccountOwnerBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwner","CORPORATE":"#/components/schemas/CorporateAccountOwner","GALILEO":"#/components/schemas/GalileoAccountOwner"}}},{"type":"object","properties":{"consumerFirstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumerfirstname","description":"First name of the person who owns the external account.\nPattern:\n- Default: 1–40 characters with at least one non-whitespace character\n- FEDNOW: 1–140 characters\n- FEDWIRE: 1–140 characters, limited to alphanumeric and special characters.\nCombined name pattern: For FEDNOW and FEDWIRE, consumerFirstName + ' ' + consumerLastName must not exceed 140 characters.\nExample: `\"Jane\"`","examples":["John"]},"consumerLastName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumerlastname","description":"Last name of the person who owns the external account. Must be set if owner type is 'consumer'.\nPattern:\n- Default: 1–40 characters with at least one non-whitespace character\n- FEDNOW: 1–140 characters\n- FEDWIRE: 1–140 characters, limited to alphanumeric and special characters.\nCombined name pattern: For FEDNOW and FEDWIRE, consumerFirstName + ' ' + consumerLastName must not exceed 140 characters.\nExample: `\"Doe\"`","examples":["Smith"]}},"x-discriminator-default-value":"CONSUMER"}]},"ConsumerAccountOwnerResponse":{"allOf":[{"description":"Owner information for the linked external account.","properties":{"type":{"description":"Type of account owner:","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"description":"Relationship of the account owner to the program account.","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type","ownershipType"],"title":"AccountOwnerResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwnerResponse","CORPORATE":"#/components/schemas/CorporateAccountOwnerResponse","GALILEO":"#/components/schemas/GalileoAccountOwnerResponse"}}},{"type":"object","properties":{"consumerFirstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumerfirstname","description":"First name of consumer. Must be set if `ownerType` is 'consumer'.","examples":["John"]},"consumerLastName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumerlastname","description":"Last name of consumer. Must be set if `ownerType` is 'consumer'.","examples":["Smith"]}},"x-discriminator-default-value":"CONSUMER"}]},"ConsumerIdentification":{"allOf":[{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},{"type":"object","x-discriminator-default-value":"CONSUMER"}]},"CorporateAccountOwner":{"allOf":[{"description":"Owner information for the external account.","properties":{"type":{"description":"Type of entity that owns the external account.\nExample: `\"CONSUMER\"`","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"default":"FIRST_PARTY","description":"Relationship of the account owner to the program account.\nExample: `\"FIRST_PARTY\"`","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type"],"title":"AccountOwnerBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwner","CORPORATE":"#/components/schemas/CorporateAccountOwner","GALILEO":"#/components/schemas/GalileoAccountOwner"}}},{"type":"object","properties":{"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Businessname","description":"Legal name of the business that owns the external account.\nPattern:\n- Default: 1–40 characters with at least one non-whitespace character\n- FEDNOW: 1–140 characters\n- FEDWIRE: 1–140 characters, limited to alphanumeric and special characters. Example: `\"ABC Corporation\"`","examples":["ABC Corp"]}},"x-discriminator-default-value":"CORPORATE"}]},"CorporateAccountOwnerResponse":{"allOf":[{"description":"Owner information for the linked external account.","properties":{"type":{"description":"Type of account owner:","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"description":"Relationship of the account owner to the program account.","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type","ownershipType"],"title":"AccountOwnerResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwnerResponse","CORPORATE":"#/components/schemas/CorporateAccountOwnerResponse","GALILEO":"#/components/schemas/GalileoAccountOwnerResponse"}}},{"type":"object","properties":{"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Businessname","description":"Name of business. Must be set if `ownerType` is 'business'","examples":["ABC Corp"]}},"x-discriminator-default-value":"CORPORATE"}]},"CorporateIdentification":{"allOf":[{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},{"type":"object","properties":{"anyBic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Anybic","description":"Business Identifier Code (BIC) for the organization. Typically an 8 or 11 character SWIFT code.\n\nFedNow: Maps to ISO 20022 Id/OrgId/AnyBIC."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier (LEI) for the organization. Typically a 20 character alphanumeric code.\n\nFedNow: Maps to ISO 20022 Id/OrgId/LEI."}},"x-discriminator-default-value":"CORPORATE"}]},"CreateExternalAccountLinkRequest":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> of the account.\nPattern: PRN \nExample: `\"074103447228\"`","examples":["074103447228"]},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","description":"Display name for the remote account. Not considered to be sensitive data.\nPattern: 1–34 characters with at least one non-whitespace character.\nExample: `\"Celia College Fund\"`","examples":["Celia College Fund","dest name 1"]},"owner":{"description":"Owner information for the external account.","properties":{"type":{"description":"Type of entity that owns the external account.\nExample: `\"CONSUMER\"`","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"default":"FIRST_PARTY","description":"Relationship of the account owner to the program account.\nExample: `\"FIRST_PARTY\"`","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type"],"title":"AccountOwnerBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwner","CORPORATE":"#/components/schemas/CorporateAccountOwner","GALILEO":"#/components/schemas/GalileoAccountOwner"}}},"details":{"description":"Card or bank details for the external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseRequest","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetails","CARD":"#/components/schemas/CardAccountDetails"}}},"validation":{"description":"Details for validating the external account link.","properties":{"type":{"description":"Specifies the validation method required for the external account link.\nPattern: enum\nExample: `\"CLIENT\"`","default":"CLIENT","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Indicates the current status of the validation process.\nPattern: enum\nExample: `\"PENDING\"`","default":"PENDING","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Reason","description":"Provides additional context or a reason for the current validation status.\nPattern: Alphanumeric string\nExample: `\"Validated successfully\"`"}},"type":"object","title":"ExternalAccountLinkValidation"}},"type":"object","required":["accountNo","owner","details","validation"],"title":"CreateExternalAccountLinkRequest"},"CreateExternalAccountLinkResponse":{"properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."}},"type":"object","required":["externalAccountLinkId"],"title":"CreateExternalAccountLinkResponse"},"CreateTransferRequest":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> associated with this transfer.\nPattern: PRN\nExample: `\"074103447228\"`"},"paymentMethod":{"description":"Payment network to use for the transfer.\nRail-specific validation: `CARD` requires the `sourceAccount` to be `GALILEO` and `creditOrDebit` to be `DEBIT` or `CREDIT`.\nExample: `\"CARD\"`","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"},"currencyAmount":{"description":"Request-side currency amount. Raises BadRequestException (400) on invalid client input.","properties":{"amount":{"type":"number","examples":[199.32]},"currency":{"type":"string","title":"Currency","description":"Currency code following ISO 4217 standard.\nValidation: Exactly 3 uppercase letters.\nPattern: ^[A-Z]{3}$\nExample: 'USD' (US Dollar), 'EUR' (Euro), 'GBP' (British Pound)","default":"USD","examples":["USD"]}},"type":"object","required":["amount"],"title":"CurrencyAmount"},"creditOrDebit":{"description":"Posting type indicating debit or credit.\n\n- DEBIT: Debit transaction (funds withdrawn)\n- CREDIT: Credit transaction (funds deposited)","type":"string","enum":["DEBIT","CREDIT"],"title":"PostingType"},"sourceAccount":{"description":"Identifies the account's role in the transaction.\n\nIf used as the **sourceAccount**, this is the account being debited. For push transfers (withdrawals), use the\nSoFi Tech Solutions account; for pull transfers (deposits), use the linked external account.\n\nIf used as the **destinationAccount**, this is the account being credited. For push transfers, use the linked\nexternal account; for pull transfers, use the SoFi Tech Solutions account.","properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/AccountRequest","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReference","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccount"}}},"destinationAccount":{"description":"Identifies the account's role in the transaction.\n\nIf used as the **sourceAccount**, this is the account being debited. For push transfers (withdrawals), use the\nSoFi Tech Solutions account; for pull transfers (deposits), use the linked external account.\n\nIf used as the **destinationAccount**, this is the account being credited. For push transfers, use the linked\nexternal account; for pull transfers, use the SoFi Tech Solutions account.","properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/AccountRequest","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReference","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccount"}}},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Externalid","description":"Client-defined identifier for tracking and reconciliation.\nPattern: Alphanumeric string\nExample: `My-Internal-ID-123`"},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purpose","description":"Reason for the transfer.\nPattern: Alphanumeric string\nValidation:\n- Default: Alphanumeric string\n- FEDWIRE: Limited to alphanumeric and special characters: @&/\\'\"\\`~()<>$#%+-={}*|[]^.,?!;:_\nExample: \"`Bill Payment`\""},"remittanceInfo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remittanceinfo","description":"Additional details about the transfer, such as an invoice number.\nPattern: Alphanumeric string\nValidation:\n- Default: Alphanumeric string\n- FEDWIRE: 1-140 characters, limited to alphanumeric and special characters: @&/\\'\"`~()<>$#%+-={}*|[]^.,?!;:_\nExample: \"`Invoice #456-ABC`\""},"returnDetails":{"anyOf":[{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Reason code describing why the transaction was returned.\nValidation:\n- FEDNOW: Required. Uses ISO 20022 External Status Reason Codes (pacs.002 StsRsnInf/Rsn/Cd). Must be 1-4 characters. Common codes include AC01 (Incorrect account number), AC03 (Invalid creditor account number), AC04 (Closed account number), AC06 (Blocked account), AC13 (Invalid debtor account type), AC14 (Invalid agent), AC15 (Account details changed), AG01 (Transaction forbidden). Refer to ISO 20022 ExternalCodeSets for the complete list of reason codes.","examples":["AC03","AC04"]},"additionalInfo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additionalinfo","description":"Optional additional context for the return.\nValidation:\n- FEDNOW: Maximum 105 characters. Maps to ISO 20022 pacs.002 StsRsnInf/AddtlInf.","examples":["Account closed by customer request"]},"originalTransactionId":{"type":"string","format":"uuid","title":"Originaltransactionid","description":"Reference to the original transaction being returned (transferId).","examples":["123e4567-e89b-12d3-a456-426614174000"]}},"type":"object","required":["originalTransactionId"],"title":"ReturnDetails","description":"Payment return information for reversing a previous transfer."},{"type":"null"}],"description":"Payment return information. If present, this request initiates a return/reversal of a previous transfer.\n\nWhen provided, the following fields take on return-specific meanings:\n- `currencyAmount`: The amount being returned (supports partial returns, must be less than or equal to the original amount)\n- `sourceAccount`: Account initiating the return.\n- `destinationAccount`: Account receiving the return.\n- `paymentMethod`: Payment rail used for the return.\n\nSee `ReturnDetails` class documentation for additional return fields and requirements."},"destinationEntities":{"anyOf":[{"properties":{"instructedAgent":{"anyOf":[{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification number. Required if bic is not provided.\nFor US banks: 9-digit ABA/RTN. For foreign banks: local clearing code.\nWhen provided without clearingSystemId, defaults to USABA."},"clearingSystemId":{"anyOf":[{"type":"string","enum":["USABA"],"title":"ClearingSystemId"},{"type":"null"}],"description":"Identifies the clearing system for the memberId.\nOnly applicable when memberId is provided. Defaults to USABA if omitted."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"SWIFT/BIC code of the financial institution.\nExactly 8 or 11 characters. Required if memberId is not provided."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier. 20-character alphanumeric code."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Financial institution name. Max 140 characters."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Financial institution address (bank location, not account owner)."}},"type":"object","title":"FinancialAgentRequest","description":"Financial institution involved in the transfer"},{"type":"null"}],"description":"The financial institution receiving the wire on FedWire.\nFor FedWire: clearingSystemId must be USABA and memberId must be a valid 9-digit ABA/RTN."},"intermediaryAgent1":{"anyOf":[{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification number. Required if bic is not provided.\nFor US banks: 9-digit ABA/RTN. For foreign banks: local clearing code.\nWhen provided without clearingSystemId, defaults to USABA."},"clearingSystemId":{"anyOf":[{"type":"string","enum":["USABA"],"title":"ClearingSystemId"},{"type":"null"}],"description":"Identifies the clearing system for the memberId.\nOnly applicable when memberId is provided. Defaults to USABA if omitted."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"SWIFT/BIC code of the financial institution.\nExactly 8 or 11 characters. Required if memberId is not provided."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier. 20-character alphanumeric code."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Financial institution name. Max 140 characters."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Financial institution address (bank location, not account owner)."}},"type":"object","title":"FinancialAgentRequest","description":"Financial institution involved in the transfer"},{"type":"null"}],"description":"Intermediary/correspondent bank in the SWIFT chain.\nAt least bic or memberId required. When present, instructedAgent is required."},"intermediaryAccount1":{"anyOf":[{"properties":{"number":{"type":"string","title":"Number","description":"Account number or IBAN."},"type":{"description":"Type of account number.\n- IBAN: International Bank Account Number, validated per ISO 13616\n- ACCOUNT_NUMBER: Standard account identifier (default when omitted)","default":"ACCOUNT_NUMBER","type":"string","enum":["IBAN","ACCOUNT_NUMBER"],"title":"AccountNumberType"}},"type":"object","required":["number"],"title":"AccountIdentification","description":"Account identification — account number or IBAN."},{"type":"null"}],"description":"Correspondent account at the intermediary bank.\nThe account the sending bank holds AT the intermediary (not the beneficiary's account)."}},"type":"object","title":"DestinationEntitiesRequest","description":"Agent routing for international wire transfers.\n\nOnly allowed for outbound international FedWire transfers.\nWhen intermediaryAgent1 is present, instructedAgent is required."},{"type":"null"}],"description":"Agent routing for outbound international FedWire transfers.\nContains the instructed agent (receiving FI on FedWire) and optional intermediary/correspondent bank in the payment chain.\nValidation:\n- Only allowed for outbound international FedWire transfers\n- When intermediaryAgent1 is present, instructedAgent is required\n- FedWire instructedAgent: clearingSystemId must be USABA, memberId must be valid ABA/RTN"},"isCrossBorder":{"type":"boolean","title":"Iscrossborder","description":"Indicates whether this is a cross-border (international) transfer.\nCurrently supported for FEDWIRE only.","default":false}},"type":"object","required":["accountNo","paymentMethod","currencyAmount","creditOrDebit","sourceAccount","destinationAccount"],"title":"CreateTransferRequest","description":"Create a new payment transfer OR return a previous transfer.\n\nFor new transfers: Omit the `returnDetails` field.\nFor payment returns: Include the `returnDetails` field with the original transaction reference.\n\nWhen `returnDetails` is present, the request initiates a return of the original transfer.\nSee `ReturnDetails` class documentation for field meanings and return-specific behavior.\n\n**Character Set Restrictions for FEDWIRE and FEDNOW rails:**\n\nAll free-text fields (e.g. `purpose`, `remittanceInfo`, address fields, owner names, `bankName`)\nmust conform to the payment rail's character set when using FEDWIRE or FEDNOW:\n\n- **FEDWIRE**: Alphanumeric characters and special characters: @&/\\'\"` ~()<>$#%+-={}*|[]^.,?!;:_\n- **FEDNOW**: FedNow Service Character Set — alphanumeric, space, all printable ASCII special\n  characters (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~), and extended Latin characters (U+00C0–U+00FF)"},"CreateTransferResponse":{"properties":{"transferId":{"type":"string","title":"Transferid","description":"Unique identifier assigned to the newly created transfer."}},"type":"object","required":["transferId"],"title":"CreateTransferResponse"},"CurrencyAmount":{"properties":{"amount":{"type":"number","examples":[199.32]},"currency":{"type":"string","title":"Currency","description":"Currency code following ISO 4217 standard.\nValidation: Exactly 3 uppercase letters.\nPattern: ^[A-Z]{3}$\nExample: 'USD' (US Dollar), 'EUR' (Euro), 'GBP' (British Pound)","default":"USD","examples":["USD"]}},"type":"object","required":["amount"],"title":"CurrencyAmount","description":"Request-side currency amount. Raises BadRequestException (400) on invalid client input."},"CurrencyAmountResponse":{"properties":{"amount":{"type":"number","examples":[199.32]},"currency":{"type":"string","title":"Currency","description":"Currency code following ISO 4217 standard.\nValidation: Exactly 3 uppercase letters.\nPattern: ^[A-Z]{3}$\nExample: 'USD' (US Dollar), 'EUR' (Euro), 'GBP' (British Pound)","default":"USD","examples":["USD"]}},"type":"object","required":["amount"],"title":"CurrencyAmountResponse","description":"Response-side currency amount. Raises InternalServiceException (500) on invalid persisted data\n— bad values in response construction reflect server-side data integrity issues, not client error."},"CurrencyAmountStatus":{"properties":{"amount":{"type":"number","examples":[199.32]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","default":"USD","examples":["USD"]},"status":{"anyOf":[{"type":"string","enum":["NOT AVAILABLE","TIMED OUT"],"title":"BalanceStatus"},{"type":"null"}],"examples":["NOT AVAILABLE"]}},"type":"object","title":"CurrencyAmountStatus"},"DestinationEntities":{"properties":{"instructedAgent":{"anyOf":[{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification. The format depends on the clearing system specified in `clearingSystemId`.\n\nFedNow: 9-digit ABA routing number (RTN). Maps to ISO 20022 ClrSysMmbId/MmbId."},"clearingSystemId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clearingsystemid","description":"Identifies the clearing system for the member ID. Example: `USABA` for US ABA routing numbers.\n\nFedNow: Maps to ISO 20022 ClrSysId/Cd."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"Business Identifier Code (BIC) of the financial institution. 8 or 11 character SWIFT code.\n\nFedNow: Maps to ISO 20022 FinInstnId/BICFI."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier (LEI) of the financial institution. 20 character alphanumeric code.\n\nFedNow: Maps to ISO 20022 FinInstnId/LEI."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/Nm."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/PstlAdr."}},"type":"object","title":"FinancialAgent","description":"Financial institution involved in originating the transfer"},{"type":"null"}],"description":"The financial institution that receives the transfer instruction. This is typically the receiving/beneficiary bank.\n\nFedNow: Maps to ISO 20022 InstdAgt (Instructed Agent)."},"ultimateDestination":{"anyOf":[{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the entity.\n\nFedNow: Maps to ISO 20022 Nm element."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the entity.\n\nFedNow: Maps to ISO 20022 PstlAdr element."},"identification":{"anyOf":[{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},{"type":"null"}],"title":"Identification","description":"Identification details for the entity. Contains type-specific fields such as BIC and LEI for corporate entities, or other IDs for consumers.\n\nWhen absent, the entity type could not be determined (only name is known).\n\nFedNow: Maps to ISO 20022 Id element. Absent when only `Nm` is present."}},"type":"object","title":"Party","description":"Entity involved in a transfer"},{"type":"null"}],"description":"The ultimate party for whom the transfer is intended. In nested or third-party scenarios, this identifies the actual individual or entity that is the final recipient of the funds, which may differ from the account owner.\n\nFedNow: Maps to ISO 20022 UltmtCdtr (Ultimate Creditor)."}},"type":"object","title":"DestinationEntities","description":"Destination side entities - entities and agents involved in receiving the transfer"},"DestinationEntitiesRequest":{"properties":{"instructedAgent":{"anyOf":[{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification number. Required if bic is not provided.\nFor US banks: 9-digit ABA/RTN. For foreign banks: local clearing code.\nWhen provided without clearingSystemId, defaults to USABA."},"clearingSystemId":{"anyOf":[{"type":"string","enum":["USABA"],"title":"ClearingSystemId"},{"type":"null"}],"description":"Identifies the clearing system for the memberId.\nOnly applicable when memberId is provided. Defaults to USABA if omitted."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"SWIFT/BIC code of the financial institution.\nExactly 8 or 11 characters. Required if memberId is not provided."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier. 20-character alphanumeric code."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Financial institution name. Max 140 characters."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Financial institution address (bank location, not account owner)."}},"type":"object","title":"FinancialAgentRequest","description":"Financial institution involved in the transfer"},{"type":"null"}],"description":"The financial institution receiving the wire on FedWire.\nFor FedWire: clearingSystemId must be USABA and memberId must be a valid 9-digit ABA/RTN."},"intermediaryAgent1":{"anyOf":[{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification number. Required if bic is not provided.\nFor US banks: 9-digit ABA/RTN. For foreign banks: local clearing code.\nWhen provided without clearingSystemId, defaults to USABA."},"clearingSystemId":{"anyOf":[{"type":"string","enum":["USABA"],"title":"ClearingSystemId"},{"type":"null"}],"description":"Identifies the clearing system for the memberId.\nOnly applicable when memberId is provided. Defaults to USABA if omitted."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"SWIFT/BIC code of the financial institution.\nExactly 8 or 11 characters. Required if memberId is not provided."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier. 20-character alphanumeric code."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Financial institution name. Max 140 characters."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Financial institution address (bank location, not account owner)."}},"type":"object","title":"FinancialAgentRequest","description":"Financial institution involved in the transfer"},{"type":"null"}],"description":"Intermediary/correspondent bank in the SWIFT chain.\nAt least bic or memberId required. When present, instructedAgent is required."},"intermediaryAccount1":{"anyOf":[{"properties":{"number":{"type":"string","title":"Number","description":"Account number or IBAN."},"type":{"description":"Type of account number.\n- IBAN: International Bank Account Number, validated per ISO 13616\n- ACCOUNT_NUMBER: Standard account identifier (default when omitted)","default":"ACCOUNT_NUMBER","type":"string","enum":["IBAN","ACCOUNT_NUMBER"],"title":"AccountNumberType"}},"type":"object","required":["number"],"title":"AccountIdentification","description":"Account identification — account number or IBAN."},{"type":"null"}],"description":"Correspondent account at the intermediary bank.\nThe account the sending bank holds AT the intermediary (not the beneficiary's account)."}},"type":"object","title":"DestinationEntitiesRequest","description":"Agent routing for international wire transfers.\n\nOnly allowed for outbound international FedWire transfers.\nWhen intermediaryAgent1 is present, instructedAgent is required."},"Direction":{"type":"string","enum":["IN","OUT"],"title":"Direction","description":"Direction of the transfer relative to the specified account.\n\n- IN: The specified account is the destination account of the transfer\n- OUT: The specified account is the source account of the transfer\n\nNote: Direction indicates transfer flow, but actual fund movement depends on the debit/credit indicator. For example, an incoming debit or outgoing credit may both result in funds leaving the specified account."},"ErrorCode":{"type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"ErrorInfo":{"properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"},"ErrorResponse":{"properties":{"error":{"description":"Provides additional information about the error.","properties":{"code":{"description":"Identifier for the error. Possible values:","type":"string","enum":["INTERNAL_SERVICE_ERROR","VALIDATION_ERROR","BAD_REQUEST","CONCURRENT_IDEMPOTENT_REQUEST","ORIGINAL_TRANSACTION_NOT_COMPLETED","NOT_FOUND","TOO_MANY_RTNS","INVALID_LIMIT","INVALID_PAGE_TOKEN","RESOURCE_LIMIT_EXCEEDED","ME_NOT_CONFIGURED","ME_NOT_ENABLED","ME_PROGRAM_MISCONFIGURED"],"title":"ErrorCode"},"message":{"type":"string","title":"Message","description":"Short description of the error."},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Contains details about the error when available. For example, which fields has validations problems or which action fails."}},"type":"object","required":["code","message"],"title":"ErrorInfo"}},"type":"object","required":["error"],"title":"ErrorResponse"},"ExternalAccountDetails":{"allOf":[{"properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/ExternalAccountDetails","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReferenceResponse","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccountResponse"}}},{"type":"object","properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","DELETED","PENDING","FAILED"],"title":"ExternalAccountLinkStatus"},{"type":"null"}],"description":"Status of the external account link."},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","description":"Display name for the remote account. Not considered to be sensitive data. \nPattern: Max 34 alphanumeric, punctuation\nExample: `\"Celia College Fund\"`","examples":["Celia College Fund","dest name 1"]},"owner":{"description":"Owner information for the linked external account.","properties":{"type":{"description":"Type of account owner:","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"description":"Relationship of the account owner to the program account.","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type","ownershipType"],"title":"AccountOwnerResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwnerResponse","CORPORATE":"#/components/schemas/CorporateAccountOwnerResponse","GALILEO":"#/components/schemas/GalileoAccountOwnerResponse"}}},"details":{"description":"Card or bank details for the linked external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseResponse","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetailsResponse","CARD":"#/components/schemas/CardAccountDetailsResponse"}}},"validation":{"description":"Validation details for the linked external account.","properties":{"type":{"description":"Type of validation:","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Status of the validation:","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason for the validation status.","title":"Status Reason"}},"required":["type","status"],"title":"ValidationResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/ExternalAccountLinkCardValidationResponse","FINICITY":"#/components/schemas/ExternalAccountLinkFinicityValidationResponse","CLIENT":"#/components/schemas/ExternalAccountLinkClientValidationResponse","LEGACY":"#/components/schemas/ExternalAccountLinkLegacyValidationResponse","MICRO_ENTRY":"#/components/schemas/ExternalAccountLinkMicroEntryValidationResponse","NONE":"#/components/schemas/ExternalAccountLinkNoValidationResponse"}}}},"required":["externalAccountLinkId","owner","details","validation"],"x-discriminator-default-value":"EXTERNAL_ACCOUNT_LINK_REQUEST"}]},"ExternalAccountLinkCardValidationResponse":{"allOf":[{"description":"Validation details for the linked external account.","properties":{"type":{"description":"Type of validation:","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Status of the validation:","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason for the validation status.","title":"Status Reason"}},"required":["type","status"],"title":"ValidationResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/ExternalAccountLinkCardValidationResponse","FINICITY":"#/components/schemas/ExternalAccountLinkFinicityValidationResponse","CLIENT":"#/components/schemas/ExternalAccountLinkClientValidationResponse","LEGACY":"#/components/schemas/ExternalAccountLinkLegacyValidationResponse","MICRO_ENTRY":"#/components/schemas/ExternalAccountLinkMicroEntryValidationResponse","NONE":"#/components/schemas/ExternalAccountLinkNoValidationResponse"}}},{"type":"object","x-discriminator-default-value":"CARD"}]},"ExternalAccountLinkClientValidationResponse":{"allOf":[{"description":"Validation details for the linked external account.","properties":{"type":{"description":"Type of validation:","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Status of the validation:","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason for the validation status.","title":"Status Reason"}},"required":["type","status"],"title":"ValidationResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/ExternalAccountLinkCardValidationResponse","FINICITY":"#/components/schemas/ExternalAccountLinkFinicityValidationResponse","CLIENT":"#/components/schemas/ExternalAccountLinkClientValidationResponse","LEGACY":"#/components/schemas/ExternalAccountLinkLegacyValidationResponse","MICRO_ENTRY":"#/components/schemas/ExternalAccountLinkMicroEntryValidationResponse","NONE":"#/components/schemas/ExternalAccountLinkNoValidationResponse"}}},{"type":"object","x-discriminator-default-value":"CLIENT"}]},"ExternalAccountLinkFinicityValidationResponse":{"allOf":[{"description":"Validation details for the linked external account.","properties":{"type":{"description":"Type of validation:","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Status of the validation:","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason for the validation status.","title":"Status Reason"}},"required":["type","status"],"title":"ValidationResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/ExternalAccountLinkCardValidationResponse","FINICITY":"#/components/schemas/ExternalAccountLinkFinicityValidationResponse","CLIENT":"#/components/schemas/ExternalAccountLinkClientValidationResponse","LEGACY":"#/components/schemas/ExternalAccountLinkLegacyValidationResponse","MICRO_ENTRY":"#/components/schemas/ExternalAccountLinkMicroEntryValidationResponse","NONE":"#/components/schemas/ExternalAccountLinkNoValidationResponse"}}},{"type":"object","x-discriminator-default-value":"FINICITY"}]},"ExternalAccountLinkLegacyValidationResponse":{"allOf":[{"description":"Validation details for the linked external account.","properties":{"type":{"description":"Type of validation:","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Status of the validation:","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason for the validation status.","title":"Status Reason"}},"required":["type","status"],"title":"ValidationResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/ExternalAccountLinkCardValidationResponse","FINICITY":"#/components/schemas/ExternalAccountLinkFinicityValidationResponse","CLIENT":"#/components/schemas/ExternalAccountLinkClientValidationResponse","LEGACY":"#/components/schemas/ExternalAccountLinkLegacyValidationResponse","MICRO_ENTRY":"#/components/schemas/ExternalAccountLinkMicroEntryValidationResponse","NONE":"#/components/schemas/ExternalAccountLinkNoValidationResponse"}}},{"type":"object","x-discriminator-default-value":"LEGACY"}]},"ExternalAccountLinkMicroEntryValidationResponse":{"allOf":[{"description":"Validation details for the linked external account.","properties":{"type":{"description":"Type of validation:","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Status of the validation:","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason for the validation status.","title":"Status Reason"}},"required":["type","status"],"title":"ValidationResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/ExternalAccountLinkCardValidationResponse","FINICITY":"#/components/schemas/ExternalAccountLinkFinicityValidationResponse","CLIENT":"#/components/schemas/ExternalAccountLinkClientValidationResponse","LEGACY":"#/components/schemas/ExternalAccountLinkLegacyValidationResponse","MICRO_ENTRY":"#/components/schemas/ExternalAccountLinkMicroEntryValidationResponse","NONE":"#/components/schemas/ExternalAccountLinkNoValidationResponse"}}},{"type":"object","properties":{"overallValidationCycles":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Overallvalidationcycles","description":"Number of micro-entry validation cycles started for this external account link."},"totalVerificationAttempts":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Totalverificationattempts","description":"Cumulative micro-entry verification attempts across cycles."}},"x-discriminator-default-value":"MICRO_ENTRY"}]},"ExternalAccountLinkNoValidationResponse":{"allOf":[{"description":"Validation details for the linked external account.","properties":{"type":{"description":"Type of validation:","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Status of the validation:","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason for the validation status.","title":"Status Reason"}},"required":["type","status"],"title":"ValidationResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/ExternalAccountLinkCardValidationResponse","FINICITY":"#/components/schemas/ExternalAccountLinkFinicityValidationResponse","CLIENT":"#/components/schemas/ExternalAccountLinkClientValidationResponse","LEGACY":"#/components/schemas/ExternalAccountLinkLegacyValidationResponse","MICRO_ENTRY":"#/components/schemas/ExternalAccountLinkMicroEntryValidationResponse","NONE":"#/components/schemas/ExternalAccountLinkNoValidationResponse"}}},{"type":"object","x-discriminator-default-value":"NONE"}]},"ExternalAccountLinkStatus":{"type":"string","enum":["ACTIVE","DELETED","PENDING","FAILED"],"title":"ExternalAccountLinkStatus"},"ExternalAccountLinkValidation":{"properties":{"type":{"description":"Specifies the validation method required for the external account link.\nPattern: enum\nExample: `\"CLIENT\"`","default":"CLIENT","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Indicates the current status of the validation process.\nPattern: enum\nExample: `\"PENDING\"`","default":"PENDING","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Reason","description":"Provides additional context or a reason for the current validation status.\nPattern: Alphanumeric string\nExample: `\"Validated successfully\"`"}},"type":"object","title":"ExternalAccountLinkValidation"},"ExternalAccountReference":{"allOf":[{"description":"Identifies the account's role in the transaction.\n\nIf used as the **sourceAccount**, this is the account being debited. For push transfers (withdrawals), use the\nSoFi Tech Solutions account; for pull transfers (deposits), use the linked external account.\n\nIf used as the **destinationAccount**, this is the account being credited. For push transfers, use the linked\nexternal account; for pull transfers, use the SoFi Tech Solutions account.","properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/AccountRequest","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReference","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccount"}}},{"type":"object","properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier of the stored external account link.\nPattern: 1-40 digits\nExample: `0359320859384728394827182394832834`"}},"required":["externalAccountLinkId"],"x-discriminator-default-value":"EXTERNAL_ACCOUNT_REFERENCE"}]},"ExternalAccountReferenceResponse":{"allOf":[{"properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/ExternalAccountDetails","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReferenceResponse","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccountResponse"}}},{"type":"object","properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier of the stored external account link.\nPattern: 1-40 digits\nExample: `0359320859384728394827182394832834`"}},"required":["externalAccountLinkId"],"x-discriminator-default-value":"EXTERNAL_ACCOUNT_REFERENCE"}]},"FedNowRailInformation":{"allOf":[{"description":"Contains payment rail specific information","properties":{"type":{"description":"Payment network used for the transfer.","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"}},"required":["type"],"title":"RailInformationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"FEDWIRE":"#/components/schemas/FedwireRailInformation","FEDNOW":"#/components/schemas/FedNowRailInformation"}}},{"type":"object","properties":{"uetr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uetr","description":"Unique End-to-End Transaction Reference (ISO 20022 UETR).","examples":["`550e8400-e29b-41d4-a716-446655440000`"]},"transactionIdentification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transactionidentification","description":"Transaction Identification supports the ISO 20022 character set.","examples":["`TXN_ID_12345`"]},"networkReferenceIdType":{"description":"Specifies the type of identifier provided in the `networkReferenceId` field. Values include `UETR` or `TRANSACTION_IDENTIFICATION`.","type":"string","enum":["UETR","TRANSACTION_IDENTIFICATION"],"title":"NetworkReferenceIdType"}},"required":["networkReferenceIdType"],"x-discriminator-default-value":"FEDNOW"}]},"FedwireRailInformation":{"allOf":[{"description":"Contains payment rail specific information","properties":{"type":{"description":"Payment network used for the transfer.","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"}},"required":["type"],"title":"RailInformationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"FEDWIRE":"#/components/schemas/FedwireRailInformation","FEDNOW":"#/components/schemas/FedNowRailInformation"}}},{"type":"object","properties":{"messages":{"items":{"properties":{"messageId":{"type":"string","title":"Messageid","description":"Unique identifier for the payment rail message."},"messageType":{"type":"string","title":"Messagetype","description":"Type of payment rail message (e.g., 'pacs.008')."}},"type":"object","required":["messageId","messageType"],"title":"MessageDetails"},"type":"array","title":"Messages","description":"List of messages related to the Fedwire transaction.","default":[]}},"x-discriminator-default-value":"FEDWIRE"}]},"FinancialAgent":{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification. The format depends on the clearing system specified in `clearingSystemId`.\n\nFedNow: 9-digit ABA routing number (RTN). Maps to ISO 20022 ClrSysMmbId/MmbId."},"clearingSystemId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clearingsystemid","description":"Identifies the clearing system for the member ID. Example: `USABA` for US ABA routing numbers.\n\nFedNow: Maps to ISO 20022 ClrSysId/Cd."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"Business Identifier Code (BIC) of the financial institution. 8 or 11 character SWIFT code.\n\nFedNow: Maps to ISO 20022 FinInstnId/BICFI."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier (LEI) of the financial institution. 20 character alphanumeric code.\n\nFedNow: Maps to ISO 20022 FinInstnId/LEI."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/Nm."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/PstlAdr."}},"type":"object","title":"FinancialAgent","description":"Financial institution involved in originating the transfer"},"FinancialAgentRequest":{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification number. Required if bic is not provided.\nFor US banks: 9-digit ABA/RTN. For foreign banks: local clearing code.\nWhen provided without clearingSystemId, defaults to USABA."},"clearingSystemId":{"anyOf":[{"type":"string","enum":["USABA"],"title":"ClearingSystemId"},{"type":"null"}],"description":"Identifies the clearing system for the memberId.\nOnly applicable when memberId is provided. Defaults to USABA if omitted."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"SWIFT/BIC code of the financial institution.\nExactly 8 or 11 characters. Required if memberId is not provided."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier. 20-character alphanumeric code."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Financial institution name. Max 140 characters."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Financial institution address (bank location, not account owner)."}},"type":"object","title":"FinancialAgentRequest","description":"Financial institution involved in the transfer"},"FinicityIntegration":{"properties":{"type":{"description":"Third-party provider used to link the account.\nExample: FINICITY","type":"string","enum":["FINICITY"],"title":"IntegrationType"},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customerid","description":"Unique customer identifier provided by the integration partner.\nPattern: Alphanumeric string\nExample: `\"1005061234\"`","examples":["1005061234"]},"accountId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accountid","description":"Unique account identifier provided by the integration partner.\nPattern: Alphanumeric string\nExample: `\"5011648377\"`","examples":["5011648377"]}},"type":"object","required":["type"],"title":"FinicityIntegration"},"GalileoAccount":{"allOf":[{"description":"Identifies the account's role in the transaction.\n\nIf used as the **sourceAccount**, this is the account being debited. For push transfers (withdrawals), use the\nSoFi Tech Solutions account; for pull transfers (deposits), use the linked external account.\n\nIf used as the **destinationAccount**, this is the account being credited. For push transfers, use the linked\nexternal account; for pull transfers, use the SoFi Tech Solutions account.","properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/AccountRequest","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReference","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccount"}}},{"type":"object","x-discriminator-default-value":"GALILEO_ACCOUNT"}]},"GalileoAccountOwner":{"allOf":[{"description":"Owner information for the external account.","properties":{"type":{"description":"Type of entity that owns the external account.\nExample: `\"CONSUMER\"`","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"default":"FIRST_PARTY","description":"Relationship of the account owner to the program account.\nExample: `\"FIRST_PARTY\"`","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type"],"title":"AccountOwnerBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwner","CORPORATE":"#/components/schemas/CorporateAccountOwner","GALILEO":"#/components/schemas/GalileoAccountOwner"}}},{"type":"object","x-discriminator-default-value":"GALILEO"}]},"GalileoAccountOwnerResponse":{"allOf":[{"description":"Owner information for the linked external account.","properties":{"type":{"description":"Type of account owner:","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"description":"Relationship of the account owner to the program account.","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type","ownershipType"],"title":"AccountOwnerResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwnerResponse","CORPORATE":"#/components/schemas/CorporateAccountOwnerResponse","GALILEO":"#/components/schemas/GalileoAccountOwnerResponse"}}},{"type":"object","x-discriminator-default-value":"GALILEO"}]},"GalileoAccountResponse":{"allOf":[{"properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/ExternalAccountDetails","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReferenceResponse","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccountResponse"}}},{"type":"object","x-discriminator-default-value":"GALILEO_ACCOUNT"}]},"GalileoFailureDetails":{"allOf":[{"description":"Contains failure details with different rejection sources","properties":{"type":{"description":"Identifies where the rejection originated.","enum":["NETWORK","GALILEO"],"title":"RejectSource","type":"string"}},"required":["type"],"title":"FailureDetailsBase","type":"object","discriminator":{"propertyName":"type","mapping":{"NETWORK":"#/components/schemas/NetworkFailureDetails","GALILEO":"#/components/schemas/GalileoFailureDetails"}}},{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Rejection reason code from SoFi Tech Solutions processor. Currently supports: `GL_VALIDATION_FAILED` - indicates SoFi Tech Solutions cannot create a valid message for the network from the provided inputs.","examples":["GL_VALIDATION_FAILED"]},"additionalInfo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additionalinfo","description":"Additional rejection context from SoFi Tech Solutions processor."}},"x-discriminator-default-value":"GALILEO"}]},"GetExternalAccountLinkAccessRequest":{"properties":{"accountNo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accountno","description":"The <<glossary:PRN>> for which to generate the secure linking session.\nRequired for GALILEO_CARD_CAPTURE integration.\nPattern: PRN\nExample: 074103447228","examples":["074103447228"]},"integration":{"description":"Third-party partner to use for the secure account-linking session.\nExample: FINICITY","type":"string","enum":["FINICITY","GALILEO_CARD_CAPTURE"],"title":"AccessIntegration"}},"type":"object","required":["integration"],"title":"GetExternalAccountLinkAccessRequest"},"GetExternalAccountLinkAccessResponse":{"properties":{"token":{"properties":{"type":{"description":"Type of token returned.\nExample: JWT","examples":["JWT","FINICITY_TOKEN"],"type":"string","enum":["JWT","FINICITY_TOKEN"],"title":"AccessTokenType"},"value":{"type":"string","title":"Value","description":"Token used to authenticate the secure session.\nFor JWT: JSON Web Token for GALILEO_CARD_CAPTURE integration.\nFor FINICITY_TOKEN: Finicity application token for API authentication.\nPattern: Token string\nExample: fqnu103294.g4234g234f.42g2345gteg","examples":["fqnu103294.g4234g234f.42g2345gteg"]},"appKey":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Appkey","description":"Application key for API authentication.\nOnly provided for FINICITY integration.\nPattern: Alphanumeric string\nExample: abc123def456","examples":["abc123def456"]}},"type":"object","required":["type","value"],"title":"TokenDetails"},"expirationTimestamp":{"type":"string","title":"Expirationtimestamp","description":"ISO 8601 timestamp when the access token expires.\nPattern: ISO 8601 format\nExample: `\"2025-06-11T09:49:20.055367-06:00\"`","examples":["2025-06-11T09:49:20.055367-06:00"]},"expirationDate":{"type":"string","title":"Expirationdate","description":"Deprecated: Use expirationTimestamp instead. ISO 8601 timestamp when the access token expires.\nPattern: ISO 8601 format\nExample: `\"2025-06-11T09:49:20.055367-06:00\"`","deprecated":true,"examples":["2025-06-11T09:49:20.055367-06:00"]}},"type":"object","required":["token","expirationTimestamp","expirationDate"],"title":"GetExternalAccountLinkAccessResponse"},"GetExternalAccountLinkRequest":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> to which the external account is linked.\nPattern: PRN\nExample: `\"074103447228\"`","examples":["074103447228"]},"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier for the specific external account link to retrieve.\nExample: `\"0359320859384728394827182394832834\"`","examples":["0359320859384728394827182394832834"]},"includeBalance":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Includebalance","description":"Specifies whether to include the external account's live balance in the response.\nExample: `true`","default":false,"examples":[true]}},"type":"object","required":["accountNo","externalAccountLinkId"],"title":"GetExternalAccountLinkRequest"},"GetExternalAccountLinkResponse":{"properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","DELETED","PENDING","FAILED"],"title":"ExternalAccountLinkStatus"},{"type":"null"}],"description":"Status of the external account link."},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","description":"Display name for the remote account. Not considered to be sensitive data. \nPattern: Max 34 alphanumeric, punctuation\nExample: `\"Celia College Fund\"`","examples":["Celia College Fund","dest name 1"]},"owner":{"description":"Owner information for the linked external account.","properties":{"type":{"description":"Type of account owner:","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"description":"Relationship of the account owner to the program account.","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type","ownershipType"],"title":"AccountOwnerResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwnerResponse","CORPORATE":"#/components/schemas/CorporateAccountOwnerResponse","GALILEO":"#/components/schemas/GalileoAccountOwnerResponse"}}},"details":{"description":"Card or bank details for the linked external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseResponse","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetailsResponse","CARD":"#/components/schemas/CardAccountDetailsResponse"}}},"validation":{"description":"Validation details for the linked external account.","properties":{"type":{"description":"Type of validation:","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Status of the validation:","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason for the validation status.","title":"Status Reason"}},"required":["type","status"],"title":"ValidationResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/ExternalAccountLinkCardValidationResponse","FINICITY":"#/components/schemas/ExternalAccountLinkFinicityValidationResponse","CLIENT":"#/components/schemas/ExternalAccountLinkClientValidationResponse","LEGACY":"#/components/schemas/ExternalAccountLinkLegacyValidationResponse","MICRO_ENTRY":"#/components/schemas/ExternalAccountLinkMicroEntryValidationResponse","NONE":"#/components/schemas/ExternalAccountLinkNoValidationResponse"}}}},"type":"object","required":["externalAccountLinkId","owner","details","validation"],"title":"GetExternalAccountLinkResponse"},"GetRoutingNumberDetailsRequest":{"properties":{"routingNumbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Routingnumbers","description":"An optional list of 9-digit RTNs. If provided, the API performs a targeted lookup. If omitted, it returns the entire directory with pagination. A maximum of 50 RTNs can be provided.","examples":[["021000021"],["021000021","111000025"]]},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit","description":"The maximum number of records to return per page. Default: 50, Maximum: 100. Only used for 'All RTNs' queries when routingNumbers is omitted.","default":50,"examples":[50,100]},"page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page","description":"The pagination token from a previous response to retrieve the next page. Only used for 'All RTNs' queries.","examples":["eyJsYXN0RXZhbHVhdGVkS2V5Ijp7InJ0biI6eyJTIjoiMDIxMDAwMDIxIn19fQ=="]}},"type":"object","title":"GetRoutingNumberDetailsRequest"},"GetRoutingNumberDetailsResponse":{"properties":{"rtns":{"items":{"properties":{"rtn":{"type":"string","pattern":"^\\d{9}$","title":"Rtn","description":"The 9-digit Routing Transit Number","examples":["021000021"]},"fiName":{"type":"string","title":"Finame","description":"The official name of the financial institution","examples":["JPMorgan Chase Bank","Bank of America"]},"paymentRails":{"items":{"properties":{"rail":{"description":"The payment rail type","examples":["FEDNOW"],"type":"string","enum":["FEDNOW"],"title":"PaymentRailType"},"status":{"description":"The current status on that rail","examples":["Online","Offline"],"type":"string","enum":["Online","Offline","Unknown"],"title":"RailStatus"},"services":{"anyOf":[{"items":{"type":"string","enum":["Credit Transfer Send Receive","Credit Transfer Receive Only","Request For Payment Receive"],"title":"PaymentRailServiceType"},"type":"array"},{"type":"null"}],"title":"Services","description":"A list of service codes the participant is enrolled in. Primarily applicable to FedNow.","examples":[["Credit Transfer Send Receive","Request For Payment Receive"]]}},"type":"object","required":["rail","status"],"title":"PaymentRailInfo"},"type":"array","title":"Paymentrails","description":"A list of payment rails the institution participates in"}},"type":"object","required":["rtn","fiName"],"title":"RoutingNumberDetails"},"type":"array","title":"Rtns","description":"A list of routing number detail objects matching the query"},"nextPage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nextpage","description":"The pagination token for retrieving the next page. Only present if more results are available.","examples":["eyJsYXN0RXZhbHVhdGVkS2V5Ijp7InJ0biI6eyJTIjoiMDIxMDAwMDIxIn19fQ=="]},"unprocessedRtns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Unprocessedrtns","description":"A list of routing numbers that could not be processed due to throttling or capacity limits","examples":[["026009593","011001234"]]}},"type":"object","title":"GetRoutingNumberDetailsResponse"},"GetTransferFilters":{"properties":{"direction":{"anyOf":[{"type":"string","enum":["IN","OUT"],"title":"Direction","description":"Direction of the transfer relative to the specified account.\n\n- IN: The specified account is the destination account of the transfer\n- OUT: The specified account is the source account of the transfer\n\nNote: Direction indicates transfer flow, but actual fund movement depends on the debit/credit indicator. For example, an incoming debit or outgoing credit may both result in funds leaving the specified account."},{"type":"null"}],"description":"Filters the list to include only incoming or outgoing transfers relative to the specified account.\nExample: `OUT`"},"paymentMethod":{"anyOf":[{"type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"},{"type":"null"}],"description":"Filters the list by the payment network used for the transfer relative to the specified account.\nExample: `ACH`"},"status":{"anyOf":[{"type":"string","enum":["CREATED","IN PROGRESS","COMPLETED","FAILED","PENDING REVIEW","SENT","ACCEPTED WITHOUT POST","BLOCKED","REJECTED","REQUESTED","REQUEST APPROVED","REQUEST REJECTED"],"title":"TransferStatus","description":"Status of the transaction.\n\n**For FedNow and FedWire transactions:**\n\n- CREATED: Initial state for transactions after creation via API call.\n- SENT: Outbound-only state indicating payment message (pacs.008 or pacs.004) successfully published to the payment network, awaiting pacs.002 status report.\n- IN PROGRESS: Transaction is being processed.\n- COMPLETED: Terminal success state. Payment network confirmed successful settlement via pacs.002 with ACSC or ACCC status.\n- FAILED: Terminal failure state. Transaction rejected by payment network or receiving FI initially.\n\n**For FedNow transactions only:**\n\n- ACCEPTED WITHOUT POST: Special intermediate state for outbound payments. Received pacs.002 with ACWP status - funds have settled but receiving Financial Institution requires additional investigation time before posting.\n- BLOCKED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Receiving FI sent pacs.002 with BLCK status - funds are blocked and will not be posted.\n- REJECTED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Received pacs.002 with RJCT status after investigation - funds must be returned via new pacs.004.\n- REQUESTED: Return has been requested (FedNow returns only).\n- REQUEST APPROVED: Return request has been approved (FedNow returns only).\n- REQUEST REJECTED: Return request has been rejected (FedNow returns only)."},{"type":"null"}],"description":"Filters the list by the current status of the transfers.\nExample: `COMPLETED`"}},"type":"object","title":"GetTransferFilters"},"GetTransferRequest":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> associated with this transfer. The `direction` field in the response identifies whether this account is the source or destination of the funds. \nPattern: PRN\nExample: \"`074103447228`\""},"transferId":{"type":"string","title":"Transferid","description":"Unique identifier for the specific transfer to retrieve.\nPattern: Alphanumeric string\nExample: \"`890e4567-e89b-12d3-a456-426614174222`\""}},"type":"object","required":["accountNo","transferId"],"title":"GetTransferRequest"},"GetTransferResponse":{"properties":{"transferId":{"type":"string","title":"Transferid","description":"The unique identifier for the transfer."},"currencyAmount":{"description":"Response-side currency amount. Raises InternalServiceException (500) on invalid persisted data\n— bad values in response construction reflect server-side data integrity issues, not client error.","properties":{"amount":{"type":"number","examples":[199.32]},"currency":{"type":"string","title":"Currency","description":"Currency code following ISO 4217 standard.\nValidation: Exactly 3 uppercase letters.\nPattern: ^[A-Z]{3}$\nExample: 'USD' (US Dollar), 'EUR' (Euro), 'GBP' (British Pound)","default":"USD","examples":["USD"]}},"type":"object","required":["amount"],"title":"CurrencyAmountResponse"},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purpose","description":"The purpose provided for the transfer."},"remittanceInfo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remittanceinfo","description":"Additional details about the transfer, such as an invoice number."},"createdDate":{"type":"string","title":"Createddate","description":"Timestamp when the transfer was created or received."},"paymentMethod":{"description":"Payment network used for the transfer.\nPossible values:","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"},"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> associated with this view of the transfer."},"sourceAccount":{"properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/ExternalAccountDetails","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReferenceResponse","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccountResponse"}}},"destinationAccount":{"properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/ExternalAccountDetails","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReferenceResponse","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccountResponse"}}},"direction":{"description":"Direction of the transfer relative to the specified account.\n\n- IN: The specified account is the destination account of the transfer\n- OUT: The specified account is the source account of the transfer\n\nNote: Direction indicates transfer flow, but actual fund movement depends on the debit/credit indicator. For example, an incoming debit or outgoing credit may both result in funds leaving the specified account.","type":"string","enum":["IN","OUT"],"title":"Direction"},"status":{"description":"Status of the transaction.\n\n**For FedNow and FedWire transactions:**\n\n- CREATED: Initial state for transactions after creation via API call.\n- SENT: Outbound-only state indicating payment message (pacs.008 or pacs.004) successfully published to the payment network, awaiting pacs.002 status report.\n- IN PROGRESS: Transaction is being processed.\n- COMPLETED: Terminal success state. Payment network confirmed successful settlement via pacs.002 with ACSC or ACCC status.\n- FAILED: Terminal failure state. Transaction rejected by payment network or receiving FI initially.\n\n**For FedNow transactions only:**\n\n- ACCEPTED WITHOUT POST: Special intermediate state for outbound payments. Received pacs.002 with ACWP status - funds have settled but receiving Financial Institution requires additional investigation time before posting.\n- BLOCKED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Receiving FI sent pacs.002 with BLCK status - funds are blocked and will not be posted.\n- REJECTED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Received pacs.002 with RJCT status after investigation - funds must be returned via new pacs.004.\n- REQUESTED: Return has been requested (FedNow returns only).\n- REQUEST APPROVED: Return request has been approved (FedNow returns only).\n- REQUEST REJECTED: Return request has been rejected (FedNow returns only).","type":"string","enum":["CREATED","IN PROGRESS","COMPLETED","FAILED","PENDING REVIEW","SENT","ACCEPTED WITHOUT POST","BLOCKED","REJECTED","REQUESTED","REQUEST APPROVED","REQUEST REJECTED"],"title":"TransferStatus"},"statusDetails":{"type":"string","title":"Statusdetails","description":"Additional details or reasons for the current transfer status."},"railInformation":{"anyOf":[{"description":"Contains payment rail specific information","properties":{"type":{"description":"Payment network used for the transfer.","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"}},"required":["type"],"title":"RailInformationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"FEDWIRE":"#/components/schemas/FedwireRailInformation","FEDNOW":"#/components/schemas/FedNowRailInformation"}}},{"type":"null"}],"title":"Railinformation","description":"Payment rail specific information. This field is optional and can be null if not applicable."},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Externalid","description":"Client-defined identifier provided when the transfer was created."},"networkReferenceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Networkreferenceid","description":"Primary network reference for the transaction. \nFor FedWire, this field contains the UETR. \nFor FedNow, it contains either the UETR or the Transaction Identification, as indicated by the `networkReferenceIdType` in the `railInformation` field."},"paymentType":{"anyOf":[{"type":"string","enum":["RETURN","CUSTOMER CREDIT TRANSFER"],"title":"PaymentType","description":"- RETURN: Funds sent back to the originator to reverse a specific transaction\n- CUSTOMER CREDIT TRANSFER: A standard payment initiated by the customer to a third party"},{"type":"null"}],"description":"Type of payment transaction."},"returnDetails":{"anyOf":[{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Reason code describing why the transaction was returned.\nValidation:\n- FEDNOW: Required. Uses ISO 20022 External Status Reason Codes (pacs.002 StsRsnInf/Rsn/Cd). Must be 1-4 characters. Common codes include AC01 (Incorrect account number), AC03 (Invalid creditor account number), AC04 (Closed account number), AC06 (Blocked account), AC13 (Invalid debtor account type), AC14 (Invalid agent), AC15 (Account details changed), AG01 (Transaction forbidden). Refer to ISO 20022 ExternalCodeSets for the complete list of reason codes.","examples":["AC03","AC04"]},"additionalInfo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additionalinfo","description":"Optional additional context for the return.\nValidation:\n- FEDNOW: Maximum 105 characters. Maps to ISO 20022 pacs.002 StsRsnInf/AddtlInf.","examples":["Account closed by customer request"]},"originalTransactionId":{"type":"string","format":"uuid","title":"Originaltransactionid","description":"Reference to the original transaction being returned (transferId).","examples":["123e4567-e89b-12d3-a456-426614174000"]}},"type":"object","required":["originalTransactionId"],"title":"ReturnDetails","description":"Payment return information for reversing a previous transfer."},{"type":"null"}],"description":"Information about a return. Present only when `paymentType` is 'RETURN'. For FedNow, fields align to ISO 20022 pacs.002: code -> StsRsnInf/Rsn/Cd; additionalInfo -> StsRsnInf/AddtlInf."},"failureDetails":{"anyOf":[{"description":"Contains failure details with different rejection sources","properties":{"type":{"description":"Identifies where the rejection originated.","enum":["NETWORK","GALILEO"],"title":"RejectSource","type":"string"}},"required":["type"],"title":"FailureDetailsBase","type":"object","discriminator":{"propertyName":"type","mapping":{"NETWORK":"#/components/schemas/NetworkFailureDetails","GALILEO":"#/components/schemas/GalileoFailureDetails"}}},{"type":"null"}],"title":"Failuredetails","description":"Information about transaction failures including rejections from the payment network or SoFi Tech Solutions processor validation failures. For FedNow network rejections, fields align to ISO 20022 pacs.002: code -> StsRsnInf/Rsn/Cd; additionalInfo -> StsRsnInf/AddtlInf."},"sourceEntities":{"anyOf":[{"properties":{"ultimateSource":{"anyOf":[{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the entity.\n\nFedNow: Maps to ISO 20022 Nm element."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the entity.\n\nFedNow: Maps to ISO 20022 PstlAdr element."},"identification":{"anyOf":[{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},{"type":"null"}],"title":"Identification","description":"Identification details for the entity. Contains type-specific fields such as BIC and LEI for corporate entities, or other IDs for consumers.\n\nWhen absent, the entity type could not be determined (only name is known).\n\nFedNow: Maps to ISO 20022 Id element. Absent when only `Nm` is present."}},"type":"object","title":"Party","description":"Entity involved in a transfer"},{"type":"null"}],"description":"The ultimate party on whose behalf the transfer is being made. In nested or third-party scenarios, this identifies the actual individual or entity that is the source of the funds, which may differ from the account owner.\n\nFedNow: Maps to ISO 20022 UltmtDbtr (Ultimate Debtor)."},"initiatingParty":{"anyOf":[{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the entity.\n\nFedNow: Maps to ISO 20022 Nm element."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the entity.\n\nFedNow: Maps to ISO 20022 PstlAdr element."},"identification":{"anyOf":[{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},{"type":"null"}],"title":"Identification","description":"Identification details for the entity. Contains type-specific fields such as BIC and LEI for corporate entities, or other IDs for consumers.\n\nWhen absent, the entity type could not be determined (only name is known).\n\nFedNow: Maps to ISO 20022 Id element. Absent when only `Nm` is present."}},"type":"object","title":"Party","description":"Entity involved in a transfer"},{"type":"null"}],"description":"The party that initiates the transfer on behalf of the source.\n\nFedNow: Maps to ISO 20022 InitgPty (Initiating Party)."},"instructingAgent":{"anyOf":[{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification. The format depends on the clearing system specified in `clearingSystemId`.\n\nFedNow: 9-digit ABA routing number (RTN). Maps to ISO 20022 ClrSysMmbId/MmbId."},"clearingSystemId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clearingsystemid","description":"Identifies the clearing system for the member ID. Example: `USABA` for US ABA routing numbers.\n\nFedNow: Maps to ISO 20022 ClrSysId/Cd."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"Business Identifier Code (BIC) of the financial institution. 8 or 11 character SWIFT code.\n\nFedNow: Maps to ISO 20022 FinInstnId/BICFI."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier (LEI) of the financial institution. 20 character alphanumeric code.\n\nFedNow: Maps to ISO 20022 FinInstnId/LEI."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/Nm."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/PstlAdr."}},"type":"object","title":"FinancialAgent","description":"Financial institution involved in originating the transfer"},{"type":"null"}],"description":"The financial institution that sends the transfer instruction. This is typically the originating bank.\n\nFedNow: Maps to ISO 20022 InstgAgt (Instructing Agent)."}},"type":"object","title":"SourceEntities","description":"Source side entities - entities and agents involved in originating the transfer"},{"type":"null"}],"description":"Source side entities. Contains information about entities and financial institutions involved in originating the transfer, including the ultimate source of funds, initiating party, and originating financial institution.\n\nFedNow: Populated from ISO 20022 message elements."},"destinationEntities":{"anyOf":[{"properties":{"instructedAgent":{"anyOf":[{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification. The format depends on the clearing system specified in `clearingSystemId`.\n\nFedNow: 9-digit ABA routing number (RTN). Maps to ISO 20022 ClrSysMmbId/MmbId."},"clearingSystemId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clearingsystemid","description":"Identifies the clearing system for the member ID. Example: `USABA` for US ABA routing numbers.\n\nFedNow: Maps to ISO 20022 ClrSysId/Cd."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"Business Identifier Code (BIC) of the financial institution. 8 or 11 character SWIFT code.\n\nFedNow: Maps to ISO 20022 FinInstnId/BICFI."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier (LEI) of the financial institution. 20 character alphanumeric code.\n\nFedNow: Maps to ISO 20022 FinInstnId/LEI."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/Nm."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/PstlAdr."}},"type":"object","title":"FinancialAgent","description":"Financial institution involved in originating the transfer"},{"type":"null"}],"description":"The financial institution that receives the transfer instruction. This is typically the receiving/beneficiary bank.\n\nFedNow: Maps to ISO 20022 InstdAgt (Instructed Agent)."},"ultimateDestination":{"anyOf":[{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the entity.\n\nFedNow: Maps to ISO 20022 Nm element."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the entity.\n\nFedNow: Maps to ISO 20022 PstlAdr element."},"identification":{"anyOf":[{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},{"type":"null"}],"title":"Identification","description":"Identification details for the entity. Contains type-specific fields such as BIC and LEI for corporate entities, or other IDs for consumers.\n\nWhen absent, the entity type could not be determined (only name is known).\n\nFedNow: Maps to ISO 20022 Id element. Absent when only `Nm` is present."}},"type":"object","title":"Party","description":"Entity involved in a transfer"},{"type":"null"}],"description":"The ultimate party for whom the transfer is intended. In nested or third-party scenarios, this identifies the actual individual or entity that is the final recipient of the funds, which may differ from the account owner.\n\nFedNow: Maps to ISO 20022 UltmtCdtr (Ultimate Creditor)."}},"type":"object","title":"DestinationEntities","description":"Destination side entities - entities and agents involved in receiving the transfer"},{"type":"null"}],"description":"Destination side entities. Contains information about entities and financial institutions involved in receiving the transfer, including the receiving financial institution and ultimate destination of funds.\n\nFedNow: Populated from ISO 20022 message elements."}},"type":"object","required":["transferId","currencyAmount","createdDate","paymentMethod","accountNo","sourceAccount","destinationAccount","direction","status","statusDetails"],"title":"GetTransferResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"IntegrationType":{"type":"string","enum":["FINICITY"],"title":"IntegrationType"},"LegacyExternalAccount":{"properties":{"type":{"type":"string","const":"LEGACY","title":"Type","description":"Indicates the account is a legacy external account type.","default":"LEGACY"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the account holder or business."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"The address associated with the account."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"The country code for the account holder's address."},"bank":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank","description":"The name of the financial institution."},"account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account","description":"The account number, often masked."},"bankId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bankid","description":"Routing number or other bank identifier."}},"type":"object","title":"LegacyExternalAccount"},"ListExternalAccountLinksRequest":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"All external account links associated with this <<glossary:PRN>>.\nPattern: PRN\nExample: `\"074103447228\"`","examples":["074103447228"]},"limit":{"type":"integer","title":"Limit","description":"Maximum number of account links to return in the response.\nPattern: Integer, max 15\nExample: `15`","examples":[1,12,15]},"page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page","description":"Pass the `nextPage` token from a previous response to fetch the subsequent page.\nPattern: Alphanumeric token\nExample: `\"NO34BNT04TV234N6V274692376G32NNFNNF7988247923865017061N\"`","examples":["NO34BNT04TV234N6V274692376G32NNFNNF7988247923865017061N"]}},"type":"object","required":["accountNo"],"title":"ListExternalAccountLinksRequest"},"ListExternalAccountLinksResponse":{"properties":{"externalAccountLinks":{"anyOf":[{"items":{"properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","DELETED","PENDING","FAILED"],"title":"ExternalAccountLinkStatus"},{"type":"null"}],"description":"Status of the external account link."},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","description":"Display name for the remote account. Not considered to be sensitive data. \nPattern: Max 34 alphanumeric, punctuation\nExample: `\"Celia College Fund\"`","examples":["Celia College Fund","dest name 1"]},"owner":{"description":"Owner information for the linked external account.","properties":{"type":{"description":"Type of account owner:","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"description":"Relationship of the account owner to the program account.","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type","ownershipType"],"title":"AccountOwnerResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwnerResponse","CORPORATE":"#/components/schemas/CorporateAccountOwnerResponse","GALILEO":"#/components/schemas/GalileoAccountOwnerResponse"}}},"details":{"description":"Card or bank details for the linked external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseResponse","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetailsResponse","CARD":"#/components/schemas/CardAccountDetailsResponse"}}},"validation":{"description":"Validation details for the linked external account.","properties":{"type":{"description":"Type of validation:","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Status of the validation:","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason for the validation status.","title":"Status Reason"}},"required":["type","status"],"title":"ValidationResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/ExternalAccountLinkCardValidationResponse","FINICITY":"#/components/schemas/ExternalAccountLinkFinicityValidationResponse","CLIENT":"#/components/schemas/ExternalAccountLinkClientValidationResponse","LEGACY":"#/components/schemas/ExternalAccountLinkLegacyValidationResponse","MICRO_ENTRY":"#/components/schemas/ExternalAccountLinkMicroEntryValidationResponse","NONE":"#/components/schemas/ExternalAccountLinkNoValidationResponse"}}}},"type":"object","required":["externalAccountLinkId","owner","details","validation"],"title":"GetExternalAccountLinkResponse"},"type":"array"},{"type":"null"}],"title":"Externalaccountlinks","description":"List of External Account Links."},"nextPage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nextpage","description":"Token to use to retrieve the next page. If this field is missing, there are no more pages to return."}},"type":"object","required":["externalAccountLinks"],"title":"ListExternalAccountLinksResponse"},"ListTransfersRequest":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"All transfers associated with this <<glossary:PRN>>.\nPattern: PRN\nExample: `074103447228`"},"filters":{"description":"Filters the list of transfers by direction, payment method, and status.","properties":{"direction":{"anyOf":[{"type":"string","enum":["IN","OUT"],"title":"Direction","description":"Direction of the transfer relative to the specified account.\n\n- IN: The specified account is the destination account of the transfer\n- OUT: The specified account is the source account of the transfer\n\nNote: Direction indicates transfer flow, but actual fund movement depends on the debit/credit indicator. For example, an incoming debit or outgoing credit may both result in funds leaving the specified account."},{"type":"null"}],"description":"Filters the list to include only incoming or outgoing transfers relative to the specified account.\nExample: `OUT`"},"paymentMethod":{"anyOf":[{"type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"},{"type":"null"}],"description":"Filters the list by the payment network used for the transfer relative to the specified account.\nExample: `ACH`"},"status":{"anyOf":[{"type":"string","enum":["CREATED","IN PROGRESS","COMPLETED","FAILED","PENDING REVIEW","SENT","ACCEPTED WITHOUT POST","BLOCKED","REJECTED","REQUESTED","REQUEST APPROVED","REQUEST REJECTED"],"title":"TransferStatus","description":"Status of the transaction.\n\n**For FedNow and FedWire transactions:**\n\n- CREATED: Initial state for transactions after creation via API call.\n- SENT: Outbound-only state indicating payment message (pacs.008 or pacs.004) successfully published to the payment network, awaiting pacs.002 status report.\n- IN PROGRESS: Transaction is being processed.\n- COMPLETED: Terminal success state. Payment network confirmed successful settlement via pacs.002 with ACSC or ACCC status.\n- FAILED: Terminal failure state. Transaction rejected by payment network or receiving FI initially.\n\n**For FedNow transactions only:**\n\n- ACCEPTED WITHOUT POST: Special intermediate state for outbound payments. Received pacs.002 with ACWP status - funds have settled but receiving Financial Institution requires additional investigation time before posting.\n- BLOCKED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Receiving FI sent pacs.002 with BLCK status - funds are blocked and will not be posted.\n- REJECTED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Received pacs.002 with RJCT status after investigation - funds must be returned via new pacs.004.\n- REQUESTED: Return has been requested (FedNow returns only).\n- REQUEST APPROVED: Return request has been approved (FedNow returns only).\n- REQUEST REJECTED: Return request has been rejected (FedNow returns only)."},{"type":"null"}],"description":"Filters the list by the current status of the transfers.\nExample: `COMPLETED`"}},"type":"object","title":"GetTransferFilters"},"dateFrom":{"type":"string","title":"Datefrom","description":"Start date for the transaction query. Defaults to the past 30 days from the current date.\nPattern: YYYY-MM-DD or ISO 8601 date-time\nExample: `\"2025-07-13\"`","examples":["2025-07-12","2025-07-12 16:20:00","2022-05-03T12:24:37-07:00"]},"dateTo":{"type":"string","title":"Dateto","description":"End date for the transaction query. Defaults to the current date and time.\nPattern: YYYY-MM-DD or ISO 8601 datetime\nExample: `\"2025-08-13\"`","examples":["2025-07-12","2025-07-12 16:20:00","2022-05-03T12:24:37-07:00"]},"limit":{"type":"integer","title":"Limit","description":"Maximum number of transfers to return in the response.\nPattern: Integer, max 15\nExample: 15","examples":[1,12,15]},"page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page","description":"Pass the `nextPage` token from a previous response to fetch the subsequent page.\nPattern: Alphanumeric token\nExample: `\"NO34BNT04TV234N6V274692376G32NNFNNF7988247923865017061N\"`","examples":["NO34BNT04TV234N6V274692376G32NNFNNF7988247923865017061N"]}},"type":"object","required":["accountNo"],"title":"ListTransfersRequest"},"ListTransfersResponse":{"properties":{"nextPage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nextpage","description":"Token used to retrieve the next page of results. This field is null if there are no more results."},"data":{"items":{"properties":{"transferId":{"type":"string","title":"Transferid","description":"The unique identifier for the transfer."},"currencyAmount":{"description":"Response-side currency amount. Raises InternalServiceException (500) on invalid persisted data\n— bad values in response construction reflect server-side data integrity issues, not client error.","properties":{"amount":{"type":"number","examples":[199.32]},"currency":{"type":"string","title":"Currency","description":"Currency code following ISO 4217 standard.\nValidation: Exactly 3 uppercase letters.\nPattern: ^[A-Z]{3}$\nExample: 'USD' (US Dollar), 'EUR' (Euro), 'GBP' (British Pound)","default":"USD","examples":["USD"]}},"type":"object","required":["amount"],"title":"CurrencyAmountResponse"},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purpose","description":"Purpose provided for the transfer."},"createdDate":{"type":"string","title":"Createddate","description":"The date when the transfer was created or received, either a date or date-time."}},"type":"object","required":["transferId","currencyAmount","createdDate"],"title":"TransferHistoryData"},"type":"array","title":"Data","description":"A list of transfer history data objects."}},"type":"object","required":["nextPage","data"],"title":"ListTransfersResponse"},"LoadApiIntegration":{"properties":{"type":{"description":"Third-party provider such as FINICITY, PLAID, etc","type":"string","enum":["FINICITY"],"title":"IntegrationType"},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customerid","description":"The customer ID of the account.","examples":["1005061234"]},"accountId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accountid","description":"The account ID of the account.","examples":["5011648377"]},"institutionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Institutionid","description":"The institution ID of the account.","examples":["102105"]}},"type":"object","required":["type"],"title":"LoadApiIntegration"},"LoadExternalAccountLinksRequest":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> to which the new external account will be linked.\nPattern: PRN\nExample: `\"074103447228\"`","examples":["074103447228"]},"integration":{"description":"Contains the account and customer identifiers from the specified third-party provider.","properties":{"type":{"description":"Third-party provider used to link the account.\nExample: FINICITY","type":"string","enum":["FINICITY"],"title":"IntegrationType"},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customerid","description":"Unique customer identifier provided by the integration partner.\nPattern: Alphanumeric string\nExample: `\"1005061234\"`","examples":["1005061234"]},"accountId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accountid","description":"Unique account identifier provided by the integration partner.\nPattern: Alphanumeric string\nExample: `\"5011648377\"`","examples":["5011648377"]}},"type":"object","required":["type"],"title":"FinicityIntegration"},"validation":{"anyOf":[{"properties":{"type":{"description":"Specifies the validation method required for the external account link.\nPattern: enum\nExample: `\"CLIENT\"`","default":"CLIENT","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Indicates the current status of the validation process.\nPattern: enum\nExample: `\"PENDING\"`","default":"PENDING","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Reason","description":"Provides additional context or a reason for the current validation status.\nPattern: Alphanumeric string\nExample: `\"Validated successfully\"`"}},"type":"object","title":"ExternalAccountLinkValidation"},{"type":"null"}]}},"type":"object","required":["accountNo","integration"],"title":"LoadExternalAccountLinksRequest"},"LoadExternalAccountLinksResponse":{"properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."},"status":{"type":"string","title":"Status","description":"Status of the external account link.","default":"PENDING"},"integration":{"description":"Contains information about the third-party provider.","properties":{"type":{"description":"Third-party provider such as FINICITY, PLAID, etc","type":"string","enum":["FINICITY"],"title":"IntegrationType"},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customerid","description":"The customer ID of the account.","examples":["1005061234"]},"accountId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accountid","description":"The account ID of the account.","examples":["5011648377"]},"institutionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Institutionid","description":"The institution ID of the account.","examples":["102105"]}},"type":"object","required":["type"],"title":"LoadApiIntegration"}},"type":"object","required":["externalAccountLinkId","integration"],"title":"LoadExternalAccountLinksResponse"},"MessageDetails":{"properties":{"messageId":{"type":"string","title":"Messageid","description":"Unique identifier for the payment rail message."},"messageType":{"type":"string","title":"Messagetype","description":"Type of payment rail message (e.g., 'pacs.008')."}},"type":"object","required":["messageId","messageType"],"title":"MessageDetails"},"ModifiableExternalAccountLinkValidation":{"properties":{"type":{"anyOf":[{"type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},{"type":"null"}],"description":"Validation method for the external account.\nExample: CLIENT"},"status":{"anyOf":[{"type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},{"type":"null"}],"description":"Validation status of the external account.\nExample: VERIFIED"}},"type":"object","title":"ModifiableExternalAccountLinkValidation"},"ModifiableExternalAccountOwner":{"properties":{"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Primary address for the account owner."},"consumerFirstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumerfirstname","description":"First name of the individual who owns the account.\nPattern: 1-40 characters\nExample: `\"Jane\"`","examples":["John"]},"consumerLastName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumerlastname","description":"Last name of the individual who owns the account.\nPattern: 1-40 characters\nExample: `\"Doe\"`","examples":["Smith"]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Businessname","description":"Legal name of the business that owns the account.\nPattern: 1-40 characters\nExample: `\"ABC Corporation\"`","examples":["ABC Corp"]}},"type":"object","title":"ModifiableExternalAccountOwner"},"ModifiableExternalBankAccountDetails":{"allOf":[{"description":"Base class for modifiable account details","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"ModifiableAccountDetailsBase","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/ModifiableExternalBankAccountDetails","CARD":"#/components/schemas/ModifiableExternalCardAccountDetails"}}},{"type":"object","properties":{"bankAddress":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}]},"bankAccountNumber":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bankaccountnumber","description":"Full account number for the external bank account.\nPattern: Alphanumeric string\nExample: `\"324839572835\"`","examples":["324839572834"]},"bankRoutingInfo":{"anyOf":[{"items":{"properties":{"type":{"description":"Type of routing information provided.\nValues: ROUTING_NO, BIC\n- ROUTING_NO: ABA/RTN routing number\n- BIC: SWIFT/BIC code\nExample: `ROUTING_NO`","type":"string","enum":["ROUTING_NO","BIC"],"title":"RoutingInfoType"},"paymentType":{"description":"Payment rail that will use this routing information.\nExample: FEDWIRE","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"},"value":{"type":"string","title":"Value","description":"Routing identifier value.\n- For ROUTING_NO: 9-digit ABA routing number. Example: `\"124001234\"`\n- For BIC: 8 or 11-character SWIFT/BIC code. Example: `\"CHASUS33\"`, `\"NWBKGB2LXXX\"`"}},"type":"object","required":["type","paymentType","value"],"title":"RoutingInfo"},"type":"array"},{"type":"null"}],"title":"Bankroutinginfo","description":"List of routing objects for the external account."},"bankName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bankname","description":"Name of the financial institution for the external account.\nPattern: 1-40 characters\nExample: `\"AbcBank\"`","examples":["AbcBank"]}},"x-discriminator-default-value":"BANK"}]},"ModifiableExternalCardAccountDetails":{"allOf":[{"description":"Base class for modifiable account details","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"ModifiableAccountDetailsBase","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/ModifiableExternalBankAccountDetails","CARD":"#/components/schemas/ModifiableExternalCardAccountDetails"}}},{"type":"object","properties":{"cardNumber":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardnumber","description":"Full card number of the external card.\nPattern: 15-16 digit <<glossary:PAN>>\nExample: `\"4111111111111112\"`"},"cardAddress":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Billing address for the card."},"cardUseOwnerAddress":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Carduseowneraddress","description":"Whether to use the account owner's address for the `card_address` field.\n\nExample: false"},"cardExpirationDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cardexpirationdate","description":"Expiration date of the external card.\nPattern: YYYY-MM\nExample: `\"2029-11\"`"}},"x-discriminator-default-value":"CARD"}]},"ModifyExternalAccountLinkRequest":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> to which the external account is linked.\nPattern: PRN\nExample: `\"074103447228\"`","examples":["074103447228"]},"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier for the specific external account link to modify.\nPattern: 1–40 digits\nExample: `\"0359320859384728394827182394832834\"`","examples":["0359320859384728394827182394832834"]},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","description":"Display name for the remote account. Not considered to be sensitive data.\nPattern: 1–34 characters\nExample: `\"My Savings Account\"`","examples":["Celia College Fund","dest name 1"]},"owner":{"anyOf":[{"properties":{"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Primary address for the account owner."},"consumerFirstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumerfirstname","description":"First name of the individual who owns the account.\nPattern: 1-40 characters\nExample: `\"Jane\"`","examples":["John"]},"consumerLastName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumerlastname","description":"Last name of the individual who owns the account.\nPattern: 1-40 characters\nExample: `\"Doe\"`","examples":["Smith"]},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Businessname","description":"Legal name of the business that owns the account.\nPattern: 1-40 characters\nExample: `\"ABC Corporation\"`","examples":["ABC Corp"]}},"type":"object","title":"ModifiableExternalAccountOwner"},{"type":"null"}],"description":"Specifies the owner-related fields to update.","default":{}},"details":{"anyOf":[{"description":"Base class for modifiable account details","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"ModifiableAccountDetailsBase","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/ModifiableExternalBankAccountDetails","CARD":"#/components/schemas/ModifiableExternalCardAccountDetails"}}},{"type":"null"}],"title":"Details","description":"Specifies the account or card details to update."},"validation":{"anyOf":[{"properties":{"type":{"anyOf":[{"type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},{"type":"null"}],"description":"Validation method for the external account.\nExample: CLIENT"},"status":{"anyOf":[{"type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},{"type":"null"}],"description":"Validation status of the external account.\nExample: VERIFIED"}},"type":"object","title":"ModifiableExternalAccountLinkValidation"},{"type":"null"}],"description":"Specifies the validation information to update.","default":{}}},"type":"object","required":["accountNo","externalAccountLinkId"],"title":"ModifyExternalAccountLinkRequest"},"ModifyExternalAccountLinkResponse":{"properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."}},"type":"object","required":["externalAccountLinkId"],"title":"ModifyExternalAccountLinkResponse"},"NetworkFailureDetails":{"allOf":[{"description":"Contains failure details with different rejection sources","properties":{"type":{"description":"Identifies where the rejection originated.","enum":["NETWORK","GALILEO"],"title":"RejectSource","type":"string"}},"required":["type"],"title":"FailureDetailsBase","type":"object","discriminator":{"propertyName":"type","mapping":{"NETWORK":"#/components/schemas/NetworkFailureDetails","GALILEO":"#/components/schemas/GalileoFailureDetails"}}},{"type":"object","properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Rejection reason code from the payment network. For FedNow, uses ISO 20022 External Code Sets (Example: `AC03`, `AM04`, `AG01`). Code format and values vary by payment rail.","examples":["`AC03`","`AM04`","`AG01`"]},"additionalInfo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additionalinfo","description":"Additional rejection context provided by the payment network."}},"x-discriminator-default-value":"NETWORK"}]},"NetworkReferenceIdType":{"type":"string","enum":["UETR","TRANSACTION_IDENTIFICATION"],"title":"NetworkReferenceIdType"},"OtherIdentification":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"OwnershipType":{"type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"Party":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the entity.\n\nFedNow: Maps to ISO 20022 Nm element."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the entity.\n\nFedNow: Maps to ISO 20022 PstlAdr element."},"identification":{"anyOf":[{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},{"type":"null"}],"title":"Identification","description":"Identification details for the entity. Contains type-specific fields such as BIC and LEI for corporate entities, or other IDs for consumers.\n\nWhen absent, the entity type could not be determined (only name is known).\n\nFedNow: Maps to ISO 20022 Id element. Absent when only `Nm` is present."}},"type":"object","title":"Party","description":"Entity involved in a transfer"},"PaymentRailInfo":{"properties":{"rail":{"description":"The payment rail type","examples":["FEDNOW"],"type":"string","enum":["FEDNOW"],"title":"PaymentRailType"},"status":{"description":"The current status on that rail","examples":["Online","Offline"],"type":"string","enum":["Online","Offline","Unknown"],"title":"RailStatus"},"services":{"anyOf":[{"items":{"type":"string","enum":["Credit Transfer Send Receive","Credit Transfer Receive Only","Request For Payment Receive"],"title":"PaymentRailServiceType"},"type":"array"},{"type":"null"}],"title":"Services","description":"A list of service codes the participant is enrolled in. Primarily applicable to FedNow.","examples":[["Credit Transfer Send Receive","Request For Payment Receive"]]}},"type":"object","required":["rail","status"],"title":"PaymentRailInfo"},"PaymentRailServiceType":{"type":"string","enum":["Credit Transfer Send Receive","Credit Transfer Receive Only","Request For Payment Receive"],"title":"PaymentRailServiceType"},"PaymentRailType":{"type":"string","enum":["FEDNOW"],"title":"PaymentRailType"},"PaymentRails":{"type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"},"PaymentType":{"type":"string","enum":["RETURN","CUSTOMER CREDIT TRANSFER"],"title":"PaymentType","description":"- RETURN: Funds sent back to the originator to reverse a specific transaction\n- CUSTOMER CREDIT TRANSFER: A standard payment initiated by the customer to a third party"},"PostingType":{"type":"string","enum":["DEBIT","CREDIT"],"title":"PostingType","description":"Posting type indicating debit or credit.\n\n- DEBIT: Debit transaction (funds withdrawn)\n- CREDIT: Credit transaction (funds deposited)"},"RailStatus":{"type":"string","enum":["Online","Offline","Unknown"],"title":"RailStatus"},"RemoveExternalAccountLinkRequest":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> from which to remove the external account link.\nPattern: PRN\nExample: `\"074103447228\"`","examples":["074103447228"]},"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier for the specific external account link to remove.\nPattern: 1–40 digits\nExample: `\"0359320859384728394827182394832834\"`","examples":["0359320859384728394827182394832834"]}},"type":"object","required":["accountNo","externalAccountLinkId"],"title":"RemoveExternalAccountLinkRequest"},"RemoveExternalAccountLinkResponse":{"properties":{"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier that identifies the external account link in the system."}},"type":"object","required":["externalAccountLinkId"],"title":"RemoveExternalAccountLinkResponse"},"RequestAddress":{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},"ResponseAddress":{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},"ReturnDetails":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Reason code describing why the transaction was returned.\nValidation:\n- FEDNOW: Required. Uses ISO 20022 External Status Reason Codes (pacs.002 StsRsnInf/Rsn/Cd). Must be 1-4 characters. Common codes include AC01 (Incorrect account number), AC03 (Invalid creditor account number), AC04 (Closed account number), AC06 (Blocked account), AC13 (Invalid debtor account type), AC14 (Invalid agent), AC15 (Account details changed), AG01 (Transaction forbidden). Refer to ISO 20022 ExternalCodeSets for the complete list of reason codes.","examples":["AC03","AC04"]},"additionalInfo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additionalinfo","description":"Optional additional context for the return.\nValidation:\n- FEDNOW: Maximum 105 characters. Maps to ISO 20022 pacs.002 StsRsnInf/AddtlInf.","examples":["Account closed by customer request"]},"originalTransactionId":{"type":"string","format":"uuid","title":"Originaltransactionid","description":"Reference to the original transaction being returned (transferId).","examples":["123e4567-e89b-12d3-a456-426614174000"]}},"type":"object","required":["originalTransactionId"],"title":"ReturnDetails","description":"Payment return information for reversing a previous transfer."},"RoutingInfo":{"properties":{"type":{"description":"Type of routing information provided.\nValues: ROUTING_NO, BIC\n- ROUTING_NO: ABA/RTN routing number\n- BIC: SWIFT/BIC code\nExample: `ROUTING_NO`","type":"string","enum":["ROUTING_NO","BIC"],"title":"RoutingInfoType"},"paymentType":{"description":"Payment rail that will use this routing information.\nExample: FEDWIRE","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"},"value":{"type":"string","title":"Value","description":"Routing identifier value.\n- For ROUTING_NO: 9-digit ABA routing number. Example: `\"124001234\"`\n- For BIC: 8 or 11-character SWIFT/BIC code. Example: `\"CHASUS33\"`, `\"NWBKGB2LXXX\"`"}},"type":"object","required":["type","paymentType","value"],"title":"RoutingInfo"},"RoutingInfoType":{"type":"string","enum":["ROUTING_NO","BIC"],"title":"RoutingInfoType"},"RoutingNumberDetails":{"properties":{"rtn":{"type":"string","pattern":"^\\d{9}$","title":"Rtn","description":"The 9-digit Routing Transit Number","examples":["021000021"]},"fiName":{"type":"string","title":"Finame","description":"The official name of the financial institution","examples":["JPMorgan Chase Bank","Bank of America"]},"paymentRails":{"items":{"properties":{"rail":{"description":"The payment rail type","examples":["FEDNOW"],"type":"string","enum":["FEDNOW"],"title":"PaymentRailType"},"status":{"description":"The current status on that rail","examples":["Online","Offline"],"type":"string","enum":["Online","Offline","Unknown"],"title":"RailStatus"},"services":{"anyOf":[{"items":{"type":"string","enum":["Credit Transfer Send Receive","Credit Transfer Receive Only","Request For Payment Receive"],"title":"PaymentRailServiceType"},"type":"array"},{"type":"null"}],"title":"Services","description":"A list of service codes the participant is enrolled in. Primarily applicable to FedNow.","examples":[["Credit Transfer Send Receive","Request For Payment Receive"]]}},"type":"object","required":["rail","status"],"title":"PaymentRailInfo"},"type":"array","title":"Paymentrails","description":"A list of payment rails the institution participates in"}},"type":"object","required":["rtn","fiName"],"title":"RoutingNumberDetails"},"SourceEntities":{"properties":{"ultimateSource":{"anyOf":[{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the entity.\n\nFedNow: Maps to ISO 20022 Nm element."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the entity.\n\nFedNow: Maps to ISO 20022 PstlAdr element."},"identification":{"anyOf":[{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},{"type":"null"}],"title":"Identification","description":"Identification details for the entity. Contains type-specific fields such as BIC and LEI for corporate entities, or other IDs for consumers.\n\nWhen absent, the entity type could not be determined (only name is known).\n\nFedNow: Maps to ISO 20022 Id element. Absent when only `Nm` is present."}},"type":"object","title":"Party","description":"Entity involved in a transfer"},{"type":"null"}],"description":"The ultimate party on whose behalf the transfer is being made. In nested or third-party scenarios, this identifies the actual individual or entity that is the source of the funds, which may differ from the account owner.\n\nFedNow: Maps to ISO 20022 UltmtDbtr (Ultimate Debtor)."},"initiatingParty":{"anyOf":[{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the entity.\n\nFedNow: Maps to ISO 20022 Nm element."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the entity.\n\nFedNow: Maps to ISO 20022 PstlAdr element."},"identification":{"anyOf":[{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},{"type":"null"}],"title":"Identification","description":"Identification details for the entity. Contains type-specific fields such as BIC and LEI for corporate entities, or other IDs for consumers.\n\nWhen absent, the entity type could not be determined (only name is known).\n\nFedNow: Maps to ISO 20022 Id element. Absent when only `Nm` is present."}},"type":"object","title":"Party","description":"Entity involved in a transfer"},{"type":"null"}],"description":"The party that initiates the transfer on behalf of the source.\n\nFedNow: Maps to ISO 20022 InitgPty (Initiating Party)."},"instructingAgent":{"anyOf":[{"properties":{"memberId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memberid","description":"Clearing system member identification. The format depends on the clearing system specified in `clearingSystemId`.\n\nFedNow: 9-digit ABA routing number (RTN). Maps to ISO 20022 ClrSysMmbId/MmbId."},"clearingSystemId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clearingsystemid","description":"Identifies the clearing system for the member ID. Example: `USABA` for US ABA routing numbers.\n\nFedNow: Maps to ISO 20022 ClrSysId/Cd."},"bic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bic","description":"Business Identifier Code (BIC) of the financial institution. 8 or 11 character SWIFT code.\n\nFedNow: Maps to ISO 20022 FinInstnId/BICFI."},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei","description":"Legal Entity Identifier (LEI) of the financial institution. 20 character alphanumeric code.\n\nFedNow: Maps to ISO 20022 FinInstnId/LEI."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/Nm."},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Postal address of the financial institution.\n\nFedNow: Maps to ISO 20022 FinInstnId/PstlAdr."}},"type":"object","title":"FinancialAgent","description":"Financial institution involved in originating the transfer"},{"type":"null"}],"description":"The financial institution that sends the transfer instruction. This is typically the originating bank.\n\nFedNow: Maps to ISO 20022 InstgAgt (Instructing Agent)."}},"type":"object","title":"SourceEntities","description":"Source side entities - entities and agents involved in originating the transfer"},"TokenDetails":{"properties":{"type":{"description":"Type of token returned.\nExample: JWT","examples":["JWT","FINICITY_TOKEN"],"type":"string","enum":["JWT","FINICITY_TOKEN"],"title":"AccessTokenType"},"value":{"type":"string","title":"Value","description":"Token used to authenticate the secure session.\nFor JWT: JSON Web Token for GALILEO_CARD_CAPTURE integration.\nFor FINICITY_TOKEN: Finicity application token for API authentication.\nPattern: Token string\nExample: fqnu103294.g4234g234f.42g2345gteg","examples":["fqnu103294.g4234g234f.42g2345gteg"]},"appKey":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Appkey","description":"Application key for API authentication.\nOnly provided for FINICITY integration.\nPattern: Alphanumeric string\nExample: abc123def456","examples":["abc123def456"]}},"type":"object","required":["type","value"],"title":"TokenDetails"},"TransferHistoryData":{"properties":{"transferId":{"type":"string","title":"Transferid","description":"The unique identifier for the transfer."},"currencyAmount":{"description":"Response-side currency amount. Raises InternalServiceException (500) on invalid persisted data\n— bad values in response construction reflect server-side data integrity issues, not client error.","properties":{"amount":{"type":"number","examples":[199.32]},"currency":{"type":"string","title":"Currency","description":"Currency code following ISO 4217 standard.\nValidation: Exactly 3 uppercase letters.\nPattern: ^[A-Z]{3}$\nExample: 'USD' (US Dollar), 'EUR' (Euro), 'GBP' (British Pound)","default":"USD","examples":["USD"]}},"type":"object","required":["amount"],"title":"CurrencyAmountResponse"},"purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purpose","description":"Purpose provided for the transfer."},"createdDate":{"type":"string","title":"Createddate","description":"The date when the transfer was created or received, either a date or date-time."}},"type":"object","required":["transferId","currencyAmount","createdDate"],"title":"TransferHistoryData"},"TransferStatus":{"type":"string","enum":["CREATED","IN PROGRESS","COMPLETED","FAILED","PENDING REVIEW","SENT","ACCEPTED WITHOUT POST","BLOCKED","REJECTED","REQUESTED","REQUEST APPROVED","REQUEST REJECTED"],"title":"TransferStatus","description":"Status of the transaction.\n\n**For FedNow and FedWire transactions:**\n\n- CREATED: Initial state for transactions after creation via API call.\n- SENT: Outbound-only state indicating payment message (pacs.008 or pacs.004) successfully published to the payment network, awaiting pacs.002 status report.\n- IN PROGRESS: Transaction is being processed.\n- COMPLETED: Terminal success state. Payment network confirmed successful settlement via pacs.002 with ACSC or ACCC status.\n- FAILED: Terminal failure state. Transaction rejected by payment network or receiving FI initially.\n\n**For FedNow transactions only:**\n\n- ACCEPTED WITHOUT POST: Special intermediate state for outbound payments. Received pacs.002 with ACWP status - funds have settled but receiving Financial Institution requires additional investigation time before posting.\n- BLOCKED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Receiving FI sent pacs.002 with BLCK status - funds are blocked and will not be posted.\n- REJECTED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Received pacs.002 with RJCT status after investigation - funds must be returned via new pacs.004.\n- REQUESTED: Return has been requested (FedNow returns only).\n- REQUEST APPROVED: Return request has been approved (FedNow returns only).\n- REQUEST REJECTED: Return request has been rejected (FedNow returns only)."},"ValidateExternalAccountLinkRequest":{"properties":{"accountNo":{"type":"string","title":"Accountno","description":"The <<glossary:PRN>> to which the external account link belongs.\nPattern: PRN\nExample: `\"074103447228\"`","examples":["074103447228"]},"externalAccountLinkId":{"type":"string","title":"Externalaccountlinkid","description":"Unique identifier for the micro-entry external account link to validate.\n(use the value returned by createExternalAccountLink for MICRO_ENTRY validation).\nPattern: 1–40 digits\nExample: `\"12345\"`","examples":["12345"]},"amount1":{"type":"string","title":"Amount1","description":"First micro-deposit amount submitted by the account holder.\nExample: `\"0.03\"` or `\".5\"`","examples":["0.03"]},"amount2":{"type":"string","title":"Amount2","description":"Second micro-deposit amount submitted by the account holder.\nExample: `\"0.07\"` or `\".07\"`","examples":["0.07"]}},"type":"object","required":["accountNo","externalAccountLinkId","amount1","amount2"],"title":"ValidateExternalAccountLinkRequest"},"ValidateExternalAccountLinkResponse":{"properties":{"linkStatus":{"type":"string","title":"Linkstatus","description":"External account link status after validation (e.g. PENDING, ACTIVE, FAILED)."},"validationStatus":{"type":"string","title":"Validationstatus","description":"Micro-entry validation status after this attempt (e.g. PENDING, PASSED, FAILED)."},"attemptsRemaining":{"type":"integer","title":"Attemptsremaining","description":"Number of micro-entry verification attempts remaining in the current cycle."},"isTerminal":{"type":"boolean","title":"Isterminal","description":"True when the link reached a terminal state (ACTIVE or FAILED) and will not accept further attempts."},"statusReason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statusreason","description":"Reason code when validation failed or the link is terminal."},"originationPending":{"type":"boolean","title":"Originationpending","description":"True when micro-deposits have not yet originated; no verification attempt was consumed.","default":false}},"type":"object","required":["linkStatus","validationStatus","attemptsRemaining","isTerminal"],"title":"ValidateExternalAccountLinkResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"ValidationStatus":{"type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"ValidationType":{"type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"AccountReferenceBase":{"description":"Identifies the account's role in the transaction.\n\nIf used as the **sourceAccount**, this is the account being debited. For push transfers (withdrawals), use the\nSoFi Tech Solutions account; for pull transfers (deposits), use the linked external account.\n\nIf used as the **destinationAccount**, this is the account being credited. For push transfers, use the linked\nexternal account; for pull transfers, use the SoFi Tech Solutions account.","properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/AccountRequest","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReference","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccount"}}},"AccountReferenceResponseBase":{"properties":{"type":{"description":"Indicates the account category.","enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"}},"required":["type"],"title":"AccountReferenceResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"EXTERNAL_ACCOUNT_LINK_REQUEST":"#/components/schemas/ExternalAccountDetails","EXTERNAL_ACCOUNT_REFERENCE":"#/components/schemas/ExternalAccountReferenceResponse","GALILEO_ACCOUNT":"#/components/schemas/GalileoAccountResponse"}}},"AccountDetailsBaseRequest":{"description":"Card or bank details for the external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseRequest","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetails","CARD":"#/components/schemas/CardAccountDetails"}}},"AccountDetailsBaseResponse":{"description":"Card or bank details for the linked external account.","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"AccountDetailsBaseResponse","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/BankAccountDetailsResponse","CARD":"#/components/schemas/CardAccountDetailsResponse"}}},"AccountOwnerBase":{"description":"Owner information for the external account.","properties":{"type":{"description":"Type of entity that owns the external account.\nExample: `\"CONSUMER\"`","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"default":"FIRST_PARTY","description":"Relationship of the account owner to the program account.\nExample: `\"FIRST_PARTY\"`","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"RequestAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type"],"title":"AccountOwnerBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwner","CORPORATE":"#/components/schemas/CorporateAccountOwner","GALILEO":"#/components/schemas/GalileoAccountOwner"}}},"ValidationResponseBase":{"description":"Validation details for the linked external account.","properties":{"type":{"description":"Type of validation:","type":"string","enum":["CLIENT","LEGACY","CARD","FINICITY","NONE","MICRO_ENTRY"],"title":"ValidationType"},"status":{"description":"Status of the validation:","type":"string","enum":["PENDING","FAILED","PASSED","NO_VALIDATION"],"title":"ValidationStatus"},"status_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason for the validation status.","title":"Status Reason"}},"required":["type","status"],"title":"ValidationResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/ExternalAccountLinkCardValidationResponse","FINICITY":"#/components/schemas/ExternalAccountLinkFinicityValidationResponse","CLIENT":"#/components/schemas/ExternalAccountLinkClientValidationResponse","LEGACY":"#/components/schemas/ExternalAccountLinkLegacyValidationResponse","MICRO_ENTRY":"#/components/schemas/ExternalAccountLinkMicroEntryValidationResponse","NONE":"#/components/schemas/ExternalAccountLinkNoValidationResponse"}}},"AccountOwnerResponseBase":{"description":"Owner information for the linked external account.","properties":{"type":{"description":"Type of account owner:","enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"ownershipType":{"description":"Relationship of the account owner to the program account.","type":"string","enum":["FIRST_PARTY","THIRD_PARTY"],"title":"OwnershipType"},"address":{"anyOf":[{"properties":{"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1","description":"First line of the address.\nPattern:\n- Default: 1-105 characters with at least one non-whitespace character\n- FEDWIRE: 1-105 characters, limited to alphanumeric and special characters","examples":["123 sesame street"]},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2","description":"Second line of the address (apartment, suite, etc.).\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["apt 4321"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City name.\nPattern:\n- Default: 1-35 characters with at least one non-whitespace character\n- FEDWIRE: 1-35 characters, limited to alphanumeric and special characters","examples":["Brooklyn"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State or province code.\nPattern:\n- Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA')\n- FEDWIRE: 2-35 characters, limited to alphanumeric and special characters","examples":["NY"]},"zipCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode","description":"Postal code or ZIP code.\nPattern:\n- Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201')\n- FEDWIRE: 1-15 characters, limited to alphanumeric and special characters","examples":["11201"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code following ISO 3166-1 alpha-2 format.\nPattern: Exactly 2 uppercase letters.\nExamples: 'US' (United States), 'MX' (Mexico)","examples":["US","MX"]}},"type":"object","title":"ResponseAddress"},{"type":"null"}],"description":"Primary address for the account owner."}},"required":["type","ownershipType"],"title":"AccountOwnerResponseBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerAccountOwnerResponse","CORPORATE":"#/components/schemas/CorporateAccountOwnerResponse","GALILEO":"#/components/schemas/GalileoAccountOwnerResponse"}}},"RailInformationBase":{"description":"Contains payment rail specific information","properties":{"type":{"description":"Payment network used for the transfer.","type":"string","enum":["ACH","FEDNOW","FEDWIRE","CARD"],"title":"PaymentRails"}},"required":["type"],"title":"RailInformationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"FEDWIRE":"#/components/schemas/FedwireRailInformation","FEDNOW":"#/components/schemas/FedNowRailInformation"}}},"FailureDetailsBase":{"description":"Contains failure details with different rejection sources","properties":{"type":{"description":"Identifies where the rejection originated.","enum":["NETWORK","GALILEO"],"title":"RejectSource","type":"string"}},"required":["type"],"title":"FailureDetailsBase","type":"object","discriminator":{"propertyName":"type","mapping":{"NETWORK":"#/components/schemas/NetworkFailureDetails","GALILEO":"#/components/schemas/GalileoFailureDetails"}}},"IdentificationBase":{"description":"Identity information for the first or third party entity","properties":{"type":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"},"other":{"default":[],"description":"List of other unique identifications for the entity. Used for proprietary or custom identifiers not covered by standard fields.\n\nFedNow: Maps to ISO 20022 Othr element.","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identification value assigned to the entity. Examples: `customer ID`, `tax ID`, `membership number`.\n\nFedNow: Maps to ISO 20022 Othr/Id."}},"type":"object","required":["id"],"title":"OtherIdentification","description":"Other identification for the first or third party entity."},"title":"Other","type":"array"}},"required":["type"],"title":"IdentificationBase","type":"object","discriminator":{"propertyName":"type","mapping":{"CONSUMER":"#/components/schemas/ConsumerIdentification","CORPORATE":"#/components/schemas/CorporateIdentification"}}},"ModifiableAccountDetailsBase":{"description":"Base class for modifiable account details","properties":{"type":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"}},"required":["type"],"title":"ModifiableAccountDetailsBase","type":"object","discriminator":{"propertyName":"type","mapping":{"BANK":"#/components/schemas/ModifiableExternalBankAccountDetails","CARD":"#/components/schemas/ModifiableExternalCardAccountDetails"}}},"AccountType":{"enum":["GALILEO_ACCOUNT","EXTERNAL_ACCOUNT_REFERENCE","EXTERNAL_ACCOUNT_LINK_REQUEST","LEGACY"],"title":"AccountType","type":"string"},"AccountDetailsType":{"description":"Type of external account being linked.","enum":["BANK","CARD"],"title":"AccountDetailsType","type":"string"},"OwnerEntityType":{"enum":["CORPORATE","CONSUMER","GALILEO"],"title":"OwnerEntityType","type":"string"},"RejectSource":{"enum":["NETWORK","GALILEO"],"title":"RejectSource","type":"string"},"IdentificationType":{"description":"Discriminator for entity identification type","enum":["CONSUMER","CORPORATE"],"title":"IdentificationType","type":"string"}}},"servers":[{"url":"{corename}.payment-hub.{env}.gpsrv.com/payment-hub/1.0/"}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}