SoFi Tech Solutions Payment Hub API 2.0 is one of 11 APIs that SoFi Technologies publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Fintech, Payments, Banking, Card Issuing, and Banking as a Service. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.
This API exposes
11 operations
across 11 paths,
organized into 2 resource areas,
and defines 129 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, {corename}.payment-hub.{env}.gpsrv.com/payment-hub/1.0/.
The identity and technical contract details declared by the specification.
AccountIdentification
object
Account identification — account number or IBAN.
2 properties
1 required
ApiIntegration
object
5 properties
1 required
BankAccountDetailsResponse
CancelTransferRequest
object
2 properties
2 required
CancelTransferResponse
object
2 properties
2 required
CardAccountDetailsResponse
CardNetworkDetails
object
6 properties
ConsumerAccountOwnerResponse
CorporateAccountOwnerResponse
CreateExternalAccountLinkRequest
object
5 properties
4 required
CreateExternalAccountLinkResponse
object
1 property
1 required
CreateTransferRequest
object
Create a new payment transfer OR return a previous transfer. For new transfers: Omit the returnDetails field. For payment returns: Include the returnDetails fi…
12 properties
6 required
CreateTransferResponse
object
1 property
1 required
CurrencyAmount
object
Request-side currency amount. Raises BadRequestException (400) on invalid client input.
2 properties
1 required
CurrencyAmountResponse
object
Response-side currency amount. Raises InternalServiceException (500) on invalid persisted data — bad values in response construction reflect server-side data i…
2 properties
1 required
CurrencyAmountStatus
object
3 properties
DestinationEntities
object
Destination side entities - entities and agents involved in receiving the transfer
2 properties
DestinationEntitiesRequest
object
Agent routing for international wire transfers. Only allowed for outbound international FedWire transfers. When intermediaryAgent1 is present, instructedAgent…
3 properties
Direction
string
Direction of the transfer relative to the specified account. - IN: The specified account is the destination account of the transfer - OUT: The specified accoun…
ErrorInfo
object
3 properties
2 required
ErrorResponse
object
1 property
1 required
ExternalAccountLinkCardValidationResponse
ExternalAccountLinkClientValidationResponse
ExternalAccountLinkFinicityValidationResponse
ExternalAccountLinkLegacyValidationResponse
ExternalAccountLinkMicroEntryValidationResponse
ExternalAccountLinkNoValidationResponse
ExternalAccountLinkStatus
string
ExternalAccountLinkValidation
object
3 properties
ExternalAccountReferenceResponse
FinancialAgent
object
Financial institution involved in originating the transfer
6 properties
FinancialAgentRequest
object
Financial institution involved in the transfer
6 properties
FinicityIntegration
object
3 properties
1 required
GalileoAccountOwnerResponse
GetExternalAccountLinkAccessRequest
object
2 properties
1 required
GetExternalAccountLinkAccessResponse
object
3 properties
3 required
GetExternalAccountLinkRequest
object
3 properties
2 required
GetExternalAccountLinkResponse
object
6 properties
4 required
GetRoutingNumberDetailsRequest
object
3 properties
GetRoutingNumberDetailsResponse
object
3 properties
GetTransferFilters
object
3 properties
GetTransferRequest
object
2 properties
2 required
GetTransferResponse
object
20 properties
10 required
HTTPValidationError
object
1 property
LegacyExternalAccount
object
7 properties
ListExternalAccountLinksRequest
object
3 properties
1 required
ListExternalAccountLinksResponse
object
2 properties
1 required
ListTransfersRequest
object
6 properties
1 required
ListTransfersResponse
object
2 properties
2 required
LoadApiIntegration
object
4 properties
1 required
LoadExternalAccountLinksRequest
object
3 properties
2 required
LoadExternalAccountLinksResponse
object
3 properties
2 required
MessageDetails
object
2 properties
2 required
ModifiableExternalAccountLinkValidation
object
2 properties
ModifiableExternalAccountOwner
object
4 properties
ModifiableExternalBankAccountDetails
ModifiableExternalCardAccountDetails
ModifyExternalAccountLinkRequest
object
6 properties
2 required
ModifyExternalAccountLinkResponse
object
1 property
1 required
NetworkReferenceIdType
string
OtherIdentification
object
Other identification for the first or third party entity.
1 property
1 required
Party
object
Entity involved in a transfer
3 properties
PaymentRailInfo
object
3 properties
2 required
PaymentRailServiceType
string
PaymentType
string
- RETURN: Funds sent back to the originator to reverse a specific transaction - CUSTOMER CREDIT TRANSFER: A standard payment initiated by the customer to a thi…
PostingType
string
Posting type indicating debit or credit. - DEBIT: Debit transaction (funds withdrawn) - CREDIT: Credit transaction (funds deposited)
RemoveExternalAccountLinkRequest
object
2 properties
2 required
RemoveExternalAccountLinkResponse
object
1 property
1 required
RequestAddress
object
6 properties
ResponseAddress
object
6 properties
ReturnDetails
object
Payment return information for reversing a previous transfer.
3 properties
1 required
RoutingInfo
object
3 properties
3 required
RoutingNumberDetails
object
3 properties
2 required
SourceEntities
object
Source side entities - entities and agents involved in originating the transfer
3 properties
TokenDetails
object
3 properties
2 required
TransferHistoryData
object
4 properties
3 required
TransferStatus
string
Status of the transaction. For FedNow and FedWire transactions: - CREATED: Initial state for transactions after creation via API call. - SENT: Outbound-only st…
ValidateExternalAccountLinkRequest
object
4 properties
4 required
ValidateExternalAccountLinkResponse
object
6 properties
4 required
ValidationError
object
3 properties
3 required
AccountReferenceBase
object
Identifies the account's role in the transaction. If used as the sourceAccount, this is the account being debited. For push transfers (withdrawals), use the So…
1 property
1 required
AccountReferenceResponseBase
object
1 property
1 required
AccountDetailsBaseRequest
object
Card or bank details for the external account.
1 property
1 required
AccountDetailsBaseResponse
object
Card or bank details for the linked external account.
1 property
1 required
AccountOwnerBase
object
Owner information for the external account.
3 properties
1 required
ValidationResponseBase
object
Validation details for the linked external account.
3 properties
2 required
AccountOwnerResponseBase
object
Owner information for the linked external account.
3 properties
2 required
RailInformationBase
object
Contains payment rail specific information
1 property
1 required
FailureDetailsBase
object
Contains failure details with different rejection sources
1 property
1 required
IdentificationBase
object
Identity information for the first or third party entity
2 properties
1 required
ModifiableAccountDetailsBase
object
Base class for modifiable account details
1 property
1 required
AccountDetailsType
string
Type of external account being linked.
IdentificationType
string
Discriminator for entity identification type
The full machine-readable OpenAPI contract behind this narrative.
Other APIs SoFi Technologies publishes across the network.
