> ## Documentation Index > Fetch the complete documentation index at: https://docs.spritz.finance/llms.txt > Use this file to discover all available pages before exploring further. # Add a bank account > Adds a new bank account as an off-ramp destination. The `type` field determines the required fields. ## Account Types | Type | Region | Required Fields | Supported Rails | |------|--------|-----------------|-----------------| | `us` | United States | `routingNumber`, `accountNumber` | ACH, RTP, Wire | | `ca` | Canada | `institutionNumber`, `transitNumber`, `accountNumber` | EFT | | `uk` | United Kingdom | `sortCode`, `accountNumber` | FPS | | `iban` | Europe / SEPA | `iban`, `bic` | SEPA | For `iban` accounts the beneficiary's address is required. When `ownership` is `personal` it is taken from your verified identity; when `thirdParty` you must supply `accountHolder.address`, including its `country`. ## Examples **US Bank Account:** ```json { "type": "us", "ownership": "personal", "routingNumber": "021000021", "accountNumber": "123456789", "accountSubtype": "checking" } ``` **Canadian Bank Account:** ```json { "type": "ca", "ownership": "thirdParty", "accountHolder": { "firstName": "Jane", "lastName": "Smith" }, "institutionNumber": "001", "transitNumber": "12345", "accountNumber": "1234567" } ``` **IBAN (SEPA) Bank Account:** ```json { "type": "iban", "ownership": "personal", "iban": "DE89370400440532013000", "bic": "COBADEFFXXX" } ``` The account will be verified before becoming active. ## OpenAPI ````yaml https://platform.spritz.finance/openapi.json post /v1/bank-accounts/ openapi: 3.0.3 info: title: Spritz Finance API version: 1.0.0 description: API for the Spritz Finance platform with RFC 9457 error handling servers: - url: https://platform.spritz.finance description: Production - url: https://sandbox.spritz.finance description: Sandbox security: [] tags: - name: Users description: User management endpoints - name: Bank Accounts description: Manage bank accounts for off-ramp destinations - name: Bills description: Manage bill pay accounts - name: Cards description: Spritz-issued debit cards - name: Auto-Ramp Accounts description: Virtual bank accounts that automatically convert fiat deposits to crypto - name: Spritz App description: >- Endpoints used by the Spritz app and internal SDKs. Excluded from the public partner spec. paths: /v1/bank-accounts/: post: tags: - Bank Accounts summary: Add a bank account description: >- Adds a new bank account as an off-ramp destination. The `type` field determines the required fields. ## Account Types | Type | Region | Required Fields | Supported Rails | |------|--------|-----------------|-----------------| | `us` | United States | `routingNumber`, `accountNumber` | ACH, RTP, Wire | | `ca` | Canada | `institutionNumber`, `transitNumber`, `accountNumber` | EFT | | `uk` | United Kingdom | `sortCode`, `accountNumber` | FPS | | `iban` | Europe / SEPA | `iban`, `bic` | SEPA | For `iban` accounts the beneficiary's address is required. When `ownership` is `personal` it is taken from your verified identity; when `thirdParty` you must supply `accountHolder.address`, including its `country`. ## Examples **US Bank Account:** ```json { "type": "us", "ownership": "personal", "routingNumber": "021000021", "accountNumber": "123456789", "accountSubtype": "checking" } ``` **Canadian Bank Account:** ```json { "type": "ca", "ownership": "thirdParty", "accountHolder": { "firstName": "Jane", "lastName": "Smith" }, "institutionNumber": "001", "transitNumber": "12345", "accountNumber": "1234567" } ``` **IBAN (SEPA) Bank Account:** ```json { "type": "iban", "ownership": "personal", "iban": "DE89370400440532013000", "bic": "COBADEFFXXX" } ``` The account will be verified before becoming active. operationId: postV1Bank-accounts requestBody: description: >- Create a bank account. The `type` field determines the required fields. required: true content: application/json: schema: description: >- Create a bank account. The `type` field determines the required fields. anyOf: - description: US bank account (ACH/Wire) type: object properties: type: description: US bank account type type: string enum: - us ownership: description: >- Who owns this bank account. "personal" = the authenticated user (holder info inferred from profile). "thirdParty" = someone else (requires accountHolder). anyOf: - type: string enum: - personal - type: string enum: - thirdParty example: personal accountHolder: description: >- Account holder details. Required when ownership is "thirdParty". type: object properties: firstName: description: Account holder first name type: string example: John lastName: description: Account holder last name type: string example: Doe address: description: Account holder mailing address type: object properties: street: type: string example: 123 Main St street2: type: string example: Apt 4B city: type: string example: New York state: type: string example: NY postalCode: type: string example: '10001' country: type: string example: US required: - street - city - state - postalCode required: - firstName - lastName routingNumber: description: 9-digit ABA routing number pattern: ^[0-9]{9}$ type: string example: '021000021' accountNumber: description: Bank account number type: string example: '123456789' accountSubtype: description: Type of bank account (checking or savings) anyOf: - type: string enum: - checking - type: string enum: - savings example: checking label: description: Friendly name for the account type: string example: Primary Checking required: - type - ownership - routingNumber - accountNumber example: type: us ownership: personal routingNumber: '021000021' accountNumber: '123456789' accountSubtype: checking - description: Canadian bank account (EFT) type: object properties: type: description: Canadian bank account type type: string enum: - ca ownership: description: >- Who owns this bank account. "personal" = the authenticated user (holder info inferred from profile). "thirdParty" = someone else (requires accountHolder). anyOf: - type: string enum: - personal - type: string enum: - thirdParty example: personal accountHolder: description: >- Account holder details. Required when ownership is "thirdParty". type: object properties: firstName: description: Account holder first name type: string example: John lastName: description: Account holder last name type: string example: Doe address: description: Account holder mailing address type: object properties: street: type: string example: 123 Main St street2: type: string example: Apt 4B city: type: string example: New York state: type: string example: NY postalCode: type: string example: '10001' country: type: string example: US required: - street - city - state - postalCode required: - firstName - lastName institutionNumber: description: 3-digit financial institution number pattern: ^[0-9]{3}$ type: string example: '001' transitNumber: description: 5-digit branch transit number pattern: ^[0-9]{5}$ type: string example: '12345' accountNumber: description: Bank account number (7-12 digits) type: string example: '1234567' accountSubtype: description: Type of bank account (checking or savings) anyOf: - type: string enum: - checking - type: string enum: - savings example: checking label: description: Friendly name for the account type: string example: TD Chequing required: - type - ownership - institutionNumber - transitNumber - accountNumber example: type: ca ownership: thirdParty accountHolder: firstName: Jane lastName: Smith institutionNumber: '001' transitNumber: '12345' accountNumber: '1234567' accountSubtype: checking - description: UK bank account (BACS/FPS) type: object properties: type: description: UK bank account type type: string enum: - uk ownership: description: >- Who owns this bank account. "personal" = the authenticated user (holder info inferred from profile). "thirdParty" = someone else (requires accountHolder). anyOf: - type: string enum: - personal - type: string enum: - thirdParty example: personal accountHolder: description: >- Account holder details. Required when ownership is "thirdParty". type: object properties: firstName: description: Account holder first name type: string example: John lastName: description: Account holder last name type: string example: Doe address: description: Account holder mailing address type: object properties: street: type: string example: 123 Main St street2: type: string example: Apt 4B city: type: string example: New York state: type: string example: NY postalCode: type: string example: '10001' country: type: string example: US required: - street - city - state - postalCode required: - firstName - lastName sortCode: description: 6-digit sort code pattern: ^[0-9]{6}$ type: string example: '108800' accountNumber: description: 8-digit account number pattern: ^[0-9]{8}$ type: string example: '00012345' label: description: Friendly name for the account type: string example: Barclays Current required: - type - ownership - sortCode - accountNumber example: type: uk ownership: personal sortCode: '108800' accountNumber: '00012345' - description: IBAN bank account (SEPA) type: object properties: type: description: IBAN bank account type (SEPA) type: string enum: - iban ownership: description: >- Who owns this bank account. "personal" = the authenticated user (holder info inferred from profile). "thirdParty" = someone else (requires accountHolder). anyOf: - type: string enum: - personal - type: string enum: - thirdParty example: personal accountHolder: description: >- Account holder details. Required when ownership is "thirdParty". type: object properties: firstName: description: Account holder first name type: string example: Hans lastName: description: Account holder last name type: string example: Müller address: description: Account holder address type: object properties: street: type: string example: Hauptstraße 1 street2: type: string example: Apt 4B city: type: string example: Berlin state: type: string example: BE postalCode: type: string example: '10115' country: description: >- ISO 3166-1 alpha-2 country code of the account holder pattern: ^[A-Z]{2}$ type: string example: DE required: - street - city - postalCode - country required: - firstName - lastName - address iban: description: >- International Bank Account Number. Spaces are ignored and lowercase is accepted. pattern: '^[A-Za-z]{2}[0-9]{2}(?: ?[A-Za-z0-9]){11,30}$' type: string example: DE89370400440532013000 bic: description: Bank Identifier Code (SWIFT) of the account's bank. pattern: ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$ type: string example: COBADEFFXXX bankName: description: Name of the account's bank minLength: 1 maxLength: 256 type: string example: Commerzbank label: description: Friendly name for the account type: string example: Commerzbank EUR required: - type - ownership - iban - bic example: type: iban ownership: thirdParty accountHolder: firstName: Hans lastName: Müller address: street: Hauptstraße 1 city: Berlin state: BE postalCode: '10115' country: DE iban: DE89370400440532013000 bic: COBADEFFXXX application/x-www-form-urlencoded: schema: description: >- Create a bank account. The `type` field determines the required fields. anyOf: - description: US bank account (ACH/Wire) type: object properties: type: description: US bank account type type: string enum: - us ownership: description: >- Who owns this bank account. "personal" = the authenticated user (holder info inferred from profile). "thirdParty" = someone else (requires accountHolder). anyOf: - type: string enum: - personal - type: string enum: - thirdParty example: personal accountHolder: description: >- Account holder details. Required when ownership is "thirdParty". type: object properties: firstName: description: Account holder first name type: string example: John lastName: description: Account holder last name type: string example: Doe address: description: Account holder mailing address type: object properties: street: type: string example: 123 Main St street2: type: string example: Apt 4B city: type: string example: New York state: type: string example: NY postalCode: type: string example: '10001' country: type: string example: US required: - street - city - state - postalCode required: - firstName - lastName routingNumber: description: 9-digit ABA routing number pattern: ^[0-9]{9}$ type: string example: '021000021' accountNumber: description: Bank account number type: string example: '123456789' accountSubtype: description: Type of bank account (checking or savings) anyOf: - type: string enum: - checking - type: string enum: - savings example: checking label: description: Friendly name for the account type: string example: Primary Checking required: - type - ownership - routingNumber - accountNumber example: type: us ownership: personal routingNumber: '021000021' accountNumber: '123456789' accountSubtype: checking - description: Canadian bank account (EFT) type: object properties: type: description: Canadian bank account type type: string enum: - ca ownership: description: >- Who owns this bank account. "personal" = the authenticated user (holder info inferred from profile). "thirdParty" = someone else (requires accountHolder). anyOf: - type: string enum: - personal - type: string enum: - thirdParty example: personal accountHolder: description: >- Account holder details. Required when ownership is "thirdParty". type: object properties: firstName: description: Account holder first name type: string example: John lastName: description: Account holder last name type: string example: Doe address: description: Account holder mailing address type: object properties: street: type: string example: 123 Main St street2: type: string example: Apt 4B city: type: string example: New York state: type: string example: NY postalCode: type: string example: '10001' country: type: string example: US required: - street - city - state - postalCode required: - firstName - lastName institutionNumber: description: 3-digit financial institution number pattern: ^[0-9]{3}$ type: string example: '001' transitNumber: description: 5-digit branch transit number pattern: ^[0-9]{5}$ type: string example: '12345' accountNumber: description: Bank account number (7-12 digits) type: string example: '1234567' accountSubtype: description: Type of bank account (checking or savings) anyOf: - type: string enum: - checking - type: string enum: - savings example: checking label: description: Friendly name for the account type: string example: TD Chequing required: - type - ownership - institutionNumber - transitNumber - accountNumber example: type: ca ownership: thirdParty accountHolder: firstName: Jane lastName: Smith institutionNumber: '001' transitNumber: '12345' accountNumber: '1234567' accountSubtype: checking - description: UK bank account (BACS/FPS) type: object properties: type: description: UK bank account type type: string enum: - uk ownership: description: >- Who owns this bank account. "personal" = the authenticated user (holder info inferred from profile). "thirdParty" = someone else (requires accountHolder). anyOf: - type: string enum: - personal - type: string enum: - thirdParty example: personal accountHolder: description: >- Account holder details. Required when ownership is "thirdParty". type: object properties: firstName: description: Account holder first name type: string example: John lastName: description: Account holder last name type: string example: Doe address: description: Account holder mailing address type: object properties: street: type: string example: 123 Main St street2: type: string example: Apt 4B city: type: string example: New York state: type: string example: NY postalCode: type: string example: '10001' country: type: string example: US required: - street - city - state - postalCode required: - firstName - lastName sortCode: description: 6-digit sort code pattern: ^[0-9]{6}$ type: string example: '108800' accountNumber: description: 8-digit account number pattern: ^[0-9]{8}$ type: string example: '00012345' label: description: Friendly name for the account type: string example: Barclays Current required: - type - ownership - sortCode - accountNumber example: type: uk ownership: personal sortCode: '108800' accountNumber: '00012345' - description: IBAN bank account (SEPA) type: object properties: type: description: IBAN bank account type (SEPA) type: string enum: - iban ownership: description: >- Who owns this bank account. "personal" = the authenticated user (holder info inferred from profile). "thirdParty" = someone else (requires accountHolder). anyOf: - type: string enum: - personal - type: string enum: - thirdParty example: personal accountHolder: description: >- Account holder details. Required when ownership is "thirdParty". type: object properties: firstName: description: Account holder first name type: string example: Hans lastName: description: Account holder last name type: string example: Müller address: description: Account holder address type: object properties: street: type: string example: Hauptstraße 1 street2: type: string example: Apt 4B city: type: string example: Berlin state: type: string example: BE postalCode: type: string example: '10115' country: description: >- ISO 3166-1 alpha-2 country code of the account holder pattern: ^[A-Z]{2}$ type: string example: DE required: - street - city - postalCode - country required: - firstName - lastName - address iban: description: >- International Bank Account Number. Spaces are ignored and lowercase is accepted. pattern: '^[A-Za-z]{2}[0-9]{2}(?: ?[A-Za-z0-9]){11,30}$' type: string example: DE89370400440532013000 bic: description: Bank Identifier Code (SWIFT) of the account's bank. pattern: ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$ type: string example: COBADEFFXXX bankName: description: Name of the account's bank minLength: 1 maxLength: 256 type: string example: Commerzbank label: description: Friendly name for the account type: string example: Commerzbank EUR required: - type - ownership - iban - bic example: type: iban ownership: thirdParty accountHolder: firstName: Hans lastName: Müller address: street: Hauptstraße 1 city: Berlin state: BE postalCode: '10115' country: DE iban: DE89370400440532013000 bic: COBADEFFXXX multipart/form-data: schema: description: >- Create a bank account. The `type` field determines the required fields. anyOf: - description: US bank account (ACH/Wire) type: object properties: type: description: US bank account type type: string enum: - us ownership: description: >- Who owns this bank account. "personal" = the authenticated user (holder info inferred from profile). "thirdParty" = someone else (requires accountHolder). anyOf: - type: string enum: - personal - type: string enum: - thirdParty example: personal accountHolder: description: >- Account holder details. Required when ownership is "thirdParty". type: object properties: firstName: description: Account holder first name type: string example: John lastName: description: Account holder last name type: string example: Doe address: description: Account holder mailing address type: object properties: street: type: string example: 123 Main St street2: type: string example: Apt 4B city: type: string example: New York state: type: string example: NY postalCode: type: string example: '10001' country: type: string example: US required: - street - city - state - postalCode required: - firstName - lastName routingNumber: description: 9-digit ABA routing number pattern: ^[0-9]{9}$ type: string example: '021000021' accountNumber: description: Bank account number type: string example: '123456789' accountSubtype: description: Type of bank account (checking or savings) anyOf: - type: string enum: - checking - type: string enum: - savings example: checking label: description: Friendly name for the account type: string example: Primary Checking required: - type - ownership - routingNumber - accountNumber example: type: us ownership: personal routingNumber: '021000021' accountNumber: '123456789' accountSubtype: checking - description: Canadian bank account (EFT) type: object properties: type: description: Canadian bank account type type: string enum: - ca ownership: description: >- Who owns this bank account. "personal" = the authenticated user (holder info inferred from profile). "thirdParty" = someone else (requires accountHolder). anyOf: - type: string enum: - personal - type: string enum: - thirdParty example: personal accountHolder: description: >- Account holder details. Required when ownership is "thirdParty". type: object properties: firstName: description: Account holder first name type: string example: John lastName: description: Account holder last name type: string example: Doe address: description: Account holder mailing address type: object properties: street: type: string example: 123 Main St street2: type: string example: Apt 4B city: type: string example: New York state: type: string example: NY postalCode: type: string example: '10001' country: type: string example: US required: - street - city - state - postalCode required: - firstName - lastName institutionNumber: description: 3-digit financial institution number pattern: ^[0-9]{3}$ type: string example: '001' transitNumber: description: 5-digit branch transit number pattern: ^[0-9]{5}$ type: string example: '12345' accountNumber: description: Bank account number (7-12 digits) type: string example: '1234567' accountSubtype: description: Type of bank account (checking or savings) anyOf: - type: string enum: - checking - type: string enum: - savings example: checking label: description: Friendly name for the account type: string example: TD Chequing required: - type - ownership - institutionNumber - transitNumber - accountNumber example: type: ca ownership: thirdParty accountHolder: firstName: Jane lastName: Smith institutionNumber: '001' transitNumber: '12345' accountNumber: '1234567' accountSubtype: checking - description: UK bank account (BACS/FPS) type: object properties: type: description: UK bank account type type: string enum: - uk ownership: description: >- Who owns this bank account. "personal" = the authenticated user (holder info inferred from profile). "thirdParty" = someone else (requires accountHolder). anyOf: - type: string enum: - personal - type: string enum: - thirdParty example: personal accountHolder: description: >- Account holder details. Required when ownership is "thirdParty". type: object properties: firstName: description: Account holder first name type: string example: John lastName: description: Account holder last name type: string example: Doe address: description: Account holder mailing address type: object properties: street: type: string example: 123 Main St street2: type: string example: Apt 4B city: type: string example: New York state: type: string example: NY postalCode: type: string example: '10001' country: type: string example: US required: - street - city - state - postalCode required: - firstName - lastName sortCode: description: 6-digit sort code pattern: ^[0-9]{6}$ type: string example: '108800' accountNumber: description: 8-digit account number pattern: ^[0-9]{8}$ type: string example: '00012345' label: description: Friendly name for the account type: string example: Barclays Current required: - type - ownership - sortCode - accountNumber example: type: uk ownership: personal sortCode: '108800' accountNumber: '00012345' - description: IBAN bank account (SEPA) type: object properties: type: description: IBAN bank account type (SEPA) type: string enum: - iban ownership: description: >- Who owns this bank account. "personal" = the authenticated user (holder info inferred from profile). "thirdParty" = someone else (requires accountHolder). anyOf: - type: string enum: - personal - type: string enum: - thirdParty example: personal accountHolder: description: >- Account holder details. Required when ownership is "thirdParty". type: object properties: firstName: description: Account holder first name type: string example: Hans lastName: description: Account holder last name type: string example: Müller address: description: Account holder address type: object properties: street: type: string example: Hauptstraße 1 street2: type: string example: Apt 4B city: type: string example: Berlin state: type: string example: BE postalCode: type: string example: '10115' country: description: >- ISO 3166-1 alpha-2 country code of the account holder pattern: ^[A-Z]{2}$ type: string example: DE required: - street - city - postalCode - country required: - firstName - lastName - address iban: description: >- International Bank Account Number. Spaces are ignored and lowercase is accepted. pattern: '^[A-Za-z]{2}[0-9]{2}(?: ?[A-Za-z0-9]){11,30}$' type: string example: DE89370400440532013000 bic: description: Bank Identifier Code (SWIFT) of the account's bank. pattern: ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$ type: string example: COBADEFFXXX bankName: description: Name of the account's bank minLength: 1 maxLength: 256 type: string example: Commerzbank label: description: Friendly name for the account type: string example: Commerzbank EUR required: - type - ownership - iban - bic example: type: iban ownership: thirdParty accountHolder: firstName: Hans lastName: Müller address: street: Hauptstraße 1 city: Berlin state: BE postalCode: '10115' country: DE iban: DE89370400440532013000 bic: COBADEFFXXX responses: '201': description: >- Bank account details. The `type` field indicates the account variant. content: application/json: schema: description: >- Bank account details. The `type` field indicates the account variant. anyOf: - description: US bank account response type: object properties: id: description: Unique identifier for the bank account type: string example: ba_abc123 status: description: Current status of the account anyOf: - type: string enum: - active - type: string enum: - pending - type: string enum: - inactive - type: string enum: - rejected example: active statusReason: description: >- Why the account is not usable, or null when no reason applies. anyOf: - type: string nullable: true enum: - account_invalid - type: string nullable: true enum: - account_closed - type: string nullable: true enum: - account_blocked example: account_invalid accountHolderName: description: Name of the account holder type: string example: John Doe institution: description: Financial institution details type: object properties: name: description: Name of the financial institution type: string example: Chase logo: description: URL to institution logo type: string example: https://example.com/chase-logo.png required: - name supportedRails: description: Payment rails available for this account type: array items: description: >- Fiat delivery rail. - `ach_standard`: ACH bank transfer, next business day. - `ach_same_day`: ACH same-day transfer, delivered same business day. - `rtp`: Real-time payment, seconds, 24/7. - `wire`: Wire transfer, same/next day. - `eft`: Electronic funds transfer, 1-2 business days. - `sepa`: SEPA transfer (EU), 1-2 business days. - `faster_payments`: UK Faster Payments, near-instant. - `push_to_card`: Push to debit card, minutes. - `bill_pay`: Bill payment rail. - `card_deposit`: Deposit to crypto card. anyOf: - type: string enum: - ach_standard - type: string enum: - ach_same_day - type: string enum: - rtp - type: string enum: - wire - type: string enum: - eft - type: string enum: - sepa - type: string enum: - faster_payments - type: string enum: - push_to_card - type: string enum: - bill_pay - type: string enum: - card_deposit example: ach_standard example: - ach_standard - rtp label: description: Friendly name for the account type: string example: Primary Checking createdAt: description: When the account was created format: date-time type: string fundingSourceId: type: string description: >- Associated opaque public funding source identifier, or null when no funding source exists for this bank account. nullable: true type: type: string enum: - us currency: type: string enum: - USD accountNumberLast4: description: Last 4 digits of account number type: string example: '6789' routingNumberLast4: description: Last 4 digits of routing number type: string example: '0021' accountSubtype: description: Type of bank account (checking or savings) anyOf: - type: string enum: - checking - type: string enum: - savings example: checking required: - id - status - statusReason - accountHolderName - supportedRails - createdAt - fundingSourceId - type - currency - accountNumberLast4 - routingNumberLast4 - description: Canadian bank account response type: object properties: id: description: Unique identifier for the bank account type: string example: ba_abc123 status: description: Current status of the account anyOf: - type: string enum: - active - type: string enum: - pending - type: string enum: - inactive - type: string enum: - rejected example: active statusReason: description: >- Why the account is not usable, or null when no reason applies. anyOf: - type: string nullable: true enum: - account_invalid - type: string nullable: true enum: - account_closed - type: string nullable: true enum: - account_blocked example: account_invalid accountHolderName: description: Name of the account holder type: string example: John Doe institution: description: Financial institution details type: object properties: name: description: Name of the financial institution type: string example: Chase logo: description: URL to institution logo type: string example: https://example.com/chase-logo.png required: - name supportedRails: description: Payment rails available for this account type: array items: description: >- Fiat delivery rail. - `ach_standard`: ACH bank transfer, next business day. - `ach_same_day`: ACH same-day transfer, delivered same business day. - `rtp`: Real-time payment, seconds, 24/7. - `wire`: Wire transfer, same/next day. - `eft`: Electronic funds transfer, 1-2 business days. - `sepa`: SEPA transfer (EU), 1-2 business days. - `faster_payments`: UK Faster Payments, near-instant. - `push_to_card`: Push to debit card, minutes. - `bill_pay`: Bill payment rail. - `card_deposit`: Deposit to crypto card. anyOf: - type: string enum: - ach_standard - type: string enum: - ach_same_day - type: string enum: - rtp - type: string enum: - wire - type: string enum: - eft - type: string enum: - sepa - type: string enum: - faster_payments - type: string enum: - push_to_card - type: string enum: - bill_pay - type: string enum: - card_deposit example: ach_standard example: - ach_standard - rtp label: description: Friendly name for the account type: string example: Primary Checking createdAt: description: When the account was created format: date-time type: string fundingSourceId: type: string description: >- Associated opaque public funding source identifier, or null when no funding source exists for this bank account. nullable: true type: type: string enum: - ca currency: type: string enum: - CAD accountNumberLast4: description: Last 4 digits of account number type: string example: '4567' institutionNumber: description: 3-digit institution number type: string example: '001' transitNumberLast3: description: Last 3 digits of transit number type: string example: '345' accountSubtype: description: Type of bank account (checking or savings) anyOf: - type: string enum: - checking - type: string enum: - savings example: checking required: - id - status - statusReason - accountHolderName - supportedRails - createdAt - fundingSourceId - type - currency - accountNumberLast4 - institutionNumber - transitNumberLast3 - description: UK bank account response type: object properties: id: description: Unique identifier for the bank account type: string example: ba_abc123 status: description: Current status of the account anyOf: - type: string enum: - active - type: string enum: - pending - type: string enum: - inactive - type: string enum: - rejected example: active statusReason: description: >- Why the account is not usable, or null when no reason applies. anyOf: - type: string nullable: true enum: - account_invalid - type: string nullable: true enum: - account_closed - type: string nullable: true enum: - account_blocked example: account_invalid accountHolderName: description: Name of the account holder type: string example: John Doe institution: description: Financial institution details type: object properties: name: description: Name of the financial institution type: string example: Chase logo: description: URL to institution logo type: string example: https://example.com/chase-logo.png required: - name supportedRails: description: Payment rails available for this account type: array items: description: >- Fiat delivery rail. - `ach_standard`: ACH bank transfer, next business day. - `ach_same_day`: ACH same-day transfer, delivered same business day. - `rtp`: Real-time payment, seconds, 24/7. - `wire`: Wire transfer, same/next day. - `eft`: Electronic funds transfer, 1-2 business days. - `sepa`: SEPA transfer (EU), 1-2 business days. - `faster_payments`: UK Faster Payments, near-instant. - `push_to_card`: Push to debit card, minutes. - `bill_pay`: Bill payment rail. - `card_deposit`: Deposit to crypto card. anyOf: - type: string enum: - ach_standard - type: string enum: - ach_same_day - type: string enum: - rtp - type: string enum: - wire - type: string enum: - eft - type: string enum: - sepa - type: string enum: - faster_payments - type: string enum: - push_to_card - type: string enum: - bill_pay - type: string enum: - card_deposit example: ach_standard example: - ach_standard - rtp label: description: Friendly name for the account type: string example: Primary Checking createdAt: description: When the account was created format: date-time type: string fundingSourceId: type: string description: >- Associated opaque public funding source identifier, or null when no funding source exists for this bank account. nullable: true type: type: string enum: - uk currency: type: string enum: - GBP accountNumberLast4: description: Last 4 digits of account number type: string example: '2345' sortCode: description: 6-digit sort code (not sensitive) type: string example: '108800' required: - id - status - statusReason - accountHolderName - supportedRails - createdAt - fundingSourceId - type - currency - accountNumberLast4 - sortCode - description: IBAN bank account response type: object properties: id: description: Unique identifier for the bank account type: string example: ba_abc123 status: description: Current status of the account anyOf: - type: string enum: - active - type: string enum: - pending - type: string enum: - inactive - type: string enum: - rejected example: active statusReason: description: >- Why the account is not usable, or null when no reason applies. anyOf: - type: string nullable: true enum: - account_invalid - type: string nullable: true enum: - account_closed - type: string nullable: true enum: - account_blocked example: account_invalid accountHolderName: description: Name of the account holder type: string example: John Doe institution: description: Financial institution details type: object properties: name: description: Name of the financial institution type: string example: Chase logo: description: URL to institution logo type: string example: https://example.com/chase-logo.png required: - name supportedRails: description: Payment rails available for this account type: array items: description: >- Fiat delivery rail. - `ach_standard`: ACH bank transfer, next business day. - `ach_same_day`: ACH same-day transfer, delivered same business day. - `rtp`: Real-time payment, seconds, 24/7. - `wire`: Wire transfer, same/next day. - `eft`: Electronic funds transfer, 1-2 business days. - `sepa`: SEPA transfer (EU), 1-2 business days. - `faster_payments`: UK Faster Payments, near-instant. - `push_to_card`: Push to debit card, minutes. - `bill_pay`: Bill payment rail. - `card_deposit`: Deposit to crypto card. anyOf: - type: string enum: - ach_standard - type: string enum: - ach_same_day - type: string enum: - rtp - type: string enum: - wire - type: string enum: - eft - type: string enum: - sepa - type: string enum: - faster_payments - type: string enum: - push_to_card - type: string enum: - bill_pay - type: string enum: - card_deposit example: ach_standard example: - ach_standard - rtp label: description: Friendly name for the account type: string example: Primary Checking createdAt: description: When the account was created format: date-time type: string fundingSourceId: type: string description: >- Associated opaque public funding source identifier, or null when no funding source exists for this bank account. nullable: true type: type: string enum: - iban currency: description: Fiat currency code anyOf: - type: string enum: - USD - type: string enum: - CAD - type: string enum: - EUR - type: string enum: - GBP example: USD ibanLast4: description: Last 4 characters of IBAN type: string example: '3000' bic: description: Bank Identifier Code type: string example: COBADEFFXXX required: - id - status - statusReason - accountHolderName - supportedRails - createdAt - fundingSourceId - type - currency - ibanLast4 '401': description: Response for status 401 content: application/json: schema: type: object properties: type: default: about:blank description: A URI reference that identifies the problem type type: string example: urn:problem-type:auth:unauthorized title: description: A short, human-readable summary of the problem type type: string example: Unauthorized status: description: The HTTP status code type: number example: 401 detail: description: A human-readable explanation specific to this occurrence type: string example: Bearer token required instance: description: A URI reference that identifies the specific occurrence type: string realm: description: The authentication realm type: string example: API scope: description: The required scope for this resource type: string example: read:users required: - title - status additionalProperties: false '404': description: Response for status 404 content: application/json: schema: type: object properties: type: default: about:blank description: A URI reference that identifies the problem type type: string title: description: A short, human-readable summary of the problem type type: string status: description: The HTTP status code type: number example: 404 detail: description: A human-readable explanation specific to this occurrence type: string instance: description: A URI reference that identifies the specific occurrence type: string resourceType: description: The type of resource that was not found type: string example: user resourceId: description: The identifier of the resource that was not found type: string required: - title - status - resourceType - resourceId additionalProperties: false '500': description: Response for status 500 content: application/json: schema: type: object properties: type: default: about:blank description: A URI reference that identifies the problem type type: string example: urn:problem-type:auth:unauthorized title: description: A short, human-readable summary of the problem type type: string example: Unauthorized status: description: The HTTP status code type: number example: 400 detail: description: A human-readable explanation specific to this occurrence type: string instance: description: A URI reference that identifies the specific occurrence type: string example: /errors/1234567890 code: description: >- Machine-readable cause, present when exactly one thing failed. Branch on this, never on `detail`, which is human-facing copy and may change. For deposit limits the vocabulary matches the `reason` values the limits API returns pre-flight. type: string example: transaction_limit field: description: The offending request field, present alongside `code`. type: string example: amountUsd retryable: description: >- Whether retrying the same request later may succeed without changing its inputs. type: boolean example: true required: - title - status additionalProperties: false security: - bearerAuth: [] - integratorJwt: [] - hmacAuth: [] integratorKey: [] timestamp: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: Cognito JWT token for regular user authentication integratorJwt: type: http scheme: bearer bearerFormat: JWT description: >- Integrator JWT token (prefix: spr_) for frontend integrator authentication. Obtained via token exchange endpoint. hmacAuth: type: apiKey in: header name: X-Signature description: >- HMAC signature authentication for backend integrators. **Required Headers:** - X-Integrator-Key: Integrator API key (format: int_...) - X-Signature: HMAC signature (format: sha256={hex}) - X-Timestamp: Unix timestamp in milliseconds - Authorization: Bearer {user-api-key} **Signature Algorithm:** HMAC-SHA256 **Signature Format:** {timestamp}.{METHOD}.{path}.{bodyHash} - timestamp: Unix timestamp in milliseconds - METHOD: HTTP method in UPPERCASE (GET, POST, etc.) - path: Request path (e.g., /v1/transactions) - bodyHash: SHA256 hex digest of request body (empty string if no body) **Timestamp Tolerance:** ±5 minutes (300 seconds) **Example:** For POST /v1/transactions with body {"amount":100} and timestamp 1234567890000: Payload: 1234567890000.POST./v1/transactions.{sha256(body)} Signature: sha256=abc123... integratorKey: type: apiKey in: header name: X-Integrator-Key description: 'Integrator API key (format: int_...) used with HMAC authentication' timestamp: type: apiKey in: header name: X-Timestamp description: >- Unix timestamp in milliseconds for replay attack prevention. Must be within 5 minutes of server time. ````