For AI agents: the docs index is at https://docs.tech.sofi.com/pro/llms.txt. The index for every project on this site is at https://docs.tech.sofi.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Guides
Recipes
API Reference
Changelog
Log into Sandbox
API Reference
Log into Sandbox
Guides
Recipes
API Reference
Changelog
About Dispute API 3.0
Program API
About Program API
System Time
Authentication
Idempotency
Responses
Status Codes and Errors
Rate Limits
Record-Set Pagination
Breaking Change Policy
PCI-Sensitive Data
Accounts and Cards
Enrollment
Create Account
post
Void Create Account
post
Create Virtual Card Account
post
Force Pass CIP
post
Run CIP
post
Get Enrollment Info
post
Start Enrollment
post
Complete Enrollment
post
Update Enrollment
post
Verify Enrollment
post
Run Enrollment CIP
post
Account Management
Get Balance
post
Update Account
post
Get Account by ID
post
Search Accounts
post
Get Related Accounts
post
Verify Account
post
Add Account
post
Get Interest
post
Get Savings Interest
post
Set User-Defined Account Field
post
Get User-Defined Account Fields
post
Charge Off Account
post
Recover Charged-Off Account
post
Get Roundup Accounts
post
Set Roundup Accounts
post
Switch Product
post
Card Management
Get Account Cards
post
Get Card
post
Activate Card
post
Replace Lost/Stolen Card
post
Get Card PIN-Change Key
post
Commit Card PIN Change
post
Reset Card PIN-Fail Count
post
Get Access Token
post
Add Card
post
Verify Card Security Code
post
Void Add Card
post
Reissue Card
post
Create Single-Use Virtual Card
post
Mobile Wallets
Create Provisioning Request
post
Get Card Tokens
post
Manage Card Token
post
Account and Card Behavior
Modify Status
post
Set Account Feature
post
Get Account Features
post
Customer Notes
Add Customer Note
post
Get Customer Note History
post
Transactions
Transaction History
Get Account Overview
post
Get Transaction History
post
Get All Transaction History
post
Network Transactions
Get Authorization History
post
Get Auth Settle Detail
post
Get Pending Merchant Credits
post
Update Pending Merchant Credit
post
Expire Authorization
post
Adjustments
Create Adjustment
post
Reverse Adjustment
post
Payments
Create Payment
post
Update Payment
post
Get Payment History
post
Fees
Assess Fee
post
Reverse Fee
post
Get Fee History
post
Get Fee Summary
post
Get Pending Fees
post
Account to Account
Create Account Transfer
post
Reverse Account Transfer
post
ACH
Add ACH Account
post
Add ACH Account Corporate
post
Get ACH Accounts
post
Modify ACH Account
post
Remove ACH Account
post
Create ACH Transaction
post
Cancel ACH Transaction
post
Get ACH Transaction History
post
Get Deposit History
post
Get Pending Deposits
post
Modify Pending Deposit Status
post
Direct Deposits
Get Direct Deposit Switch Token
post
Bill Payments
Get Billers
post
Add Paper Biller
post
Modify Paper Biller
post
Add RPPS Biller
post
Modify RPPS Biller
post
Remove Biller
post
Search Biller Directory
post
Create Bill Payment
post
Get Bill Payment History
post
Cancel Bill Payment
post
Get Scheduled Bill Payments
post
Get Billpay Switch Token
post
Holds
Create Hold
post
Get Hold History
post
Expire Hold
post
Transaction Simulation
Create Simulated Card Authorization
post
Create Simulated Card Settlement
post
Create Simulated Incoming ACH Transaction
post
Cancel Simulated Incoming ACH Transaction
post
Get Simulated Incoming ACH Transaction
post
Get All Simulated Incoming ACH Transactions
post
Account-Level Controls
Get Auth Control
post
Set Account-Level Auth Control
post
Delete Account-Level Auth Control
post
Get MCC Controls
post
Set Account-Level MCC Controls
post
Delete Account-Level MCC Control
post
Get Merchant Controls
post
Set Account-Level Merchant Control
post
Delete Account-Level Merchant Control
post
Overdraft
Get Overdraft Balance
post
Set Overdraft Limit
post
Get Overdraft Limit Change History
post
Credit
Get Credit Summary
post
Set Credit Limit
post
Get Credit Limit Change History
post
Set AutoPay Plan
post
Set AutoPay Attempt
post
Get AutoPay History
post
Get AutoPay Plan
post
Get Authorized Users
post
Corporate Credit and RTF
Set Corporate Credit Limit
post
Get Corporate Credit Summary
post
Get Corporate Credit Change History
post
Is Corporate Credit Funding Account
post
Is Corporate Credit Spending Account
post
Get RTF Account Relationship
post
Is RTF Funding Account
post
Is RTF Spending Account
post
Instant Issue
Verify Instant-Issue Card
post
Get Bulk Card Order
post
Create Bulk Card Order
post
Get Load Locations
post
Move Card Inventory
post
Move Card
post
Federal Benefit Enrollment
Get Federal Benefit Enrollments
post
Create Federal Benefit Enrollment
post
Resubmit Federal Benefit Enrollment
post
Update Federal Benefit Enrollment
post
IVR
Create IVR Call
post
Get IVR Call Status
post
Get IVR Call Identifier
post
Location Management
Get Locations
post
Create Location
post
Modify Location
post
Create Location Fee
post
Modify Location Fee
post
Corporate Hierarchy
Create Group
post
Update Group
post
Delete Groups
post
Get Groups Info
post
Get Root Groups
post
Get Group Hierarchy
post
Set Account Group Relationships
post
Remove Account Group Relationship
post
Get Account Group Relationships
post
Alerts
Set Alerts
post
Get Alerts
post
Set Alerts Blackout
post
Get Alerts Blackout
post
Get Carriers List
post
Verify On-Demand Alert Status
post
Modify On-Demand Alert Status
post
Miscellaneous
Ping
post
Get Product Info
post
Get Promontory Bank List
post
Get Ingo Customer ID
post
Get Call Status
post
Enumerations
Account Statuses
ACH Account Statuses
ACH Return Codes
ACH Transaction Statuses
Activity Type
Authorization Status Codes
Bill Payment Statuses
Card Statuses
Customer ID Types
Deposit Category Codes
Deposit Status Codes
Emboss Statuses
Enrollment Statuses
Federal Benefit Enrollment Agency Types
Federal Benefit Enrollment Statuses
Global Response Statuses
Incoming ACH Simulation Payload Values
Instant Issue Card Statuses
Limit Response Codes
Manage Card Token Values
Modify Pending Deposit Status Return Codes
Modify Status Types
Network Codes
Restricted Company Entry Descriptions Values
SEC Codes Requirements for ACH
Set Account Feature Values
Simulated Transaction Types
Special Functions
Transaction Types
On-Demand Alert Statuses
Validations
address1
Phone Validation
Special Characters
Dispute API 3.0
About Dispute API 3.0
Intake
Intake Sequence
/claim/intake/create
post
/claim/intake/retrieveReasons
post
/claim/intake/addClaimReasons
post
/claim/intake/retrieveTransactions
post
/claim/intake/addTransactions
post
/claim/intake/retrieveQuestionnaire
post
/claim/intake/retrieveOtherAccounts
post
/claim/intake/retrieveCreditTransactions
post
/claim/intake/retrieveSimilarTransactions
post
/claim/intake/addSimilarTransactions
post
/claim/intake/addQuestionnaire
post
/claim/intake/retrieveDocRequirements
post
/claim/intake/addDocuments
post
/claim/intake/retrieveSummary
post
/claim/intake/submit
post
Other Intake
/claim/intake/retrieveConfirmation
post
/claim/intake/bulkCreate
post
Attachments
/claim/attachments/add
post
Claim
/claim/list
post
/claim/details/retrieve
post
/claim/reopenRequest
post
/claim/withdrawRequest
post
Documents
/claim/documents/retrieveRequirements
post
/claim/documents/add
post
Tasks
/task/summary
post
/task/list
post
/task/details/list
post
/task/action
post
Disputed Transactions
/claim/transactions/list
post
Status
/claim/retrieve
post
Enumerations
Profile Type Differences
Status Values
Questionnaires
ACH Questionnaire
ATM Questionnaire
Fraud Questionnaire
Mastercard Questionnaire
Visa Questionnaire
Risk API 1.0
About Risk API 1.0
Risk
Get Card Transaction Fraud
post
Get Instant Verification
post
Get Money Movement Fraud
post
Enumerations
Get Instant Verification Reason Codes
Risk API 2.0
About Risk API 2.0
IVS
Verify Customer
post
Get Application Status
post
Close Application
post
Get Customer Status
post
Close Customer Account
post
Get Verification Documents
post
Payment Hub Api 2.0
About the Payment Hub API
External Account Links
Create External Account Link
post
Get External Account Link
post
Get External Account Link Access
post
List External Account Links
post
Load External Account Links
post
Modify External Account Link
post
Remove External Account Links
post
Transfers
Create Transfer
post
Get Transfer
post
Cancel Transfer
post
List Transfers
post
Loan API
About the Loan API
Loan
Simulate Loan
post
Create Loan
post
Create SMB Loan
post
Create Loan From Transactions
post
Get Loan Status
post
Create Loan Payment
post
Get Loan Payment Schedule
post
Get Loan Installment Statuses
post
Update Loan Status
post
Get Loan Transaction History
post
Public Config API
About the Public Config API
Configuration
Get Product Config
post
Enumerations
Limit Types
Load Types
Load-Limit Types
Product Categories
Product Types
Transfer Types
Transfer-Limit Types
Events API
About Events API
Events API Authentication
Paths and Content Types
Migrating to Standard Event Templates
Authorization
AAAU/BAUT: auth
webhook
AAPM: auth_payment
webhook
AIFI: atm_issuer_fee_inquiry
webhook
AUFB: auth_fallback
webhook
AUMD: auth_metadata
webhook
BEXP: auth_exp
webhook
BEXR: auth_exp_reversal
webhook
BNPD: denied_auth_buy_now_pay_later
webhook
BNSF: denied_auth_nsf
webhook
BPAN: denied_auth_bad_pan
webhook
DAUT: denied_auth
webhook
IPIN: denied_auth_invalid_pin
webhook
NACT: denied_auth_inactive_card
webhook
OATO: Auth_API_timeout
webhook
PUMP: denied_auth_gas
webhook
STPN: auth_stip_notification
webhook
SUVA: single_use_invalid_amount
webhook
SUVM: single_use_secondary_transaction
webhook
TDSS: three_ds_status
webhook
Account
AABI/BBAL/BMON: bal
webhook
AACN/GACN/SACN: mobile_activation ACN
webhook
ACCL: account_closed
webhook
ACFC: account_feature_change
webhook
ACST: account_status_change
webhook
ADPE/AFPE: agserv_PIN_change_fail
webhook
ADPS/AFPS: agserv_PIN_change_success
webhook
ADRC: addr_chg
webhook
ARDP/GRDP/SRDP: mobile_activation RDP
webhook
ATCN/GTCN/STCN: mobile_activation TCN
webhook
ATKC/GTKC/STKC/VTKC: mobile_activation TKC
webhook
ATVD/GTVD/STVD: mobile_activation TVD
webhook
ATVN/GTVN/STVN: mobile_activation TVN
webhook
ATVR/GTVR/STVR: mobile_activation TVR
webhook
AYLP/GYLP/SYLP: mobile_activation YLP
webhook
BACT: card_activated
webhook
BFID: failed_id
webhook
BNEG: neg_bal
webhook
BPSE: billpay_switch_event
webhook
CAPP: app_completed
webhook
CDFR: bulk_frozen
webhook
CHPC: cardholder_info_changed
webhook
CLIM: credit_limit_change
webhook
CRCA: ready_to_activate
webhook
CSCT: case_created
webhook
CSNT: card_status_change
webhook
CSUP: case_updated
webhook
DDSE: direct_deposit_switch_event
webhook
DSCT: dispute_created
webhook
DSFN: dispute_final_no_pc
webhook
DSFP: dispute_final_pc
webhook
DSIC: dispute_investigation_completed
webhook
DSPC: dispute_pc
webhook
ECHG: email_addr_change
webhook
FBSC: fed_benefits_status_confirmed
webhook
FBSD: fed_benefits_status_deposit
webhook
FBSM: fed_benefits_status_resubmit
webhook
FBSR: fed_benefits_status_returned
webhook
FBSS: fed_benefits_status_submitted
webhook
FBSU: fed_benefits_status_updated
webhook
FRZN: frozen
webhook
FTID: fail_id
webhook
GDBF: ext_trans_debit_fail
webhook
GDBR: ext_trans_debit_retry
webhook
ISFE: insufficient_funds_to_emboss
webhook
LBLC: low_balance_notify
webhook
LSCN: lost/stolen card no replacement
webhook
LSCR: lost/stolen card with replacement
webhook
NOTE: note
webhook
ODAA: overdraft_authorization
webhook
ODCL: overdraft_credit_limit_change
webhook
ODGP: overdraft_start_grace_period
webhook
ODIN: overdraft_opt_in
webhook
ODNB: overdraft_negative_balance
webhook
ODOT: overdraft_opt_out
webhook
ODSC: overdraft_status_change
webhook
ODSH: overdraft_excessive_use
webhook
ODSK: overdraft_suspended
webhook
ODSN: overdraft_limit_change
webhook
PCHG: profile_changed
webhook
PCIS: pin_changed_by_issuer_script
webhook
PHCH: phone_changed
webhook
PINC: PIN_changed
webhook
PNCH: system_pin_change
webhook
PSUC: card_returned
webhook
PSWC: product_switched
webhook
PTID: pass_id
webhook
RBEX: card_expiring
webhook
RTNG: pmt_hub_return
webhook
SENT: card_shipping_info
webhook
SHIP: card_shipped
webhook
TKUP: token_update
webhook
UFRZ: unfrozen
webhook
VAPI: mobile_activation API
webhook
Transaction
ACHC: ach_credit_fail
webhook
ACHR: ach_debit_fail
webhook
ACRT: ach_return
webhook
BADJ: adj
webhook
BDPM: pmt_delayed
webhook
BFEE: fee
webhook
BLVF: billpay_limit_violation
webhook
BPAR: billpay_retry
webhook
BPAY: billpay
webhook
BPCC: billpay_check_cleared
webhook
BPCL: billpay_cancelled
webhook
BPCM: billpay_check_mailed
webhook
BPCQ: billpay_request_made
webhook
BPCR: billpay_request_returned
webhook
BPEX: billpay_expired
webhook
BPMT: pmt
webhook
BRRJ: billpay_rejected
webhook
BSPF: sched_billpay_fail
webhook
BSPM: pmt_split
webhook
CRHD: create_hold
webhook
EXHD: expire_hold
webhook
FACH: ach_credit_return
webhook
FREV: fee_reversal
webhook
GDAC: greendot_auth_commit
webhook
GDAU: greendot_auth
webhook
GDFA: greendot_auth_failure
webhook
GDFC: greendot_auth_commit_fail
webhook
Settlement
SETL: setl
webhook
Enumerations
DE003 Codes
DE022 Codes
DE025 Codes
Direct Deposit Switch Failure Status Reasons
Dispute Claim Reasons
Dispute Deny Reasons
Dispute Final Statuses
Dispute Resolution
Event Codes
Events Network Codes
Payment Method Switch Failure Reasons
TDSS Values
Auth API
About Auth API
Auth API Webhook
Auth API Webhook 2.0
post
Auth API Webhook 3.0
post
Enumerations
Advice Reason Codes
AVS Codes
Business Application Identifier
CAVV Result Code
CIT and MIT Indicators
DE061 Subfields
Merchant Advice Codes
Relay Resistance Protocol Data
Service Processing Types
STIP Additional Detail
Tokenization Recommendation Reason Codes
VDCAP Info
External Trans API
About External Transactions API
Security
Retries
API Versioning
ACH Debit Webhook
ACH Debit Webhook
post
Billpay Webhook
Billpay Webhook
post
About Dispute API 3.0
Updated 6 days ago
Special Characters
Intake
Did this page help you?
Yes
No
Updated 6 days ago
Special Characters
Intake
Did this page help you?
Yes
No
