Retrieve Business Details

Retrieve Business Profile

Retrieve Business Documents

Returns the instance your API key or connection is bound to. Check type before moving money: development simulates settlement and moves no real funds, production moves real funds. onboarding_step is completed once the instance can transact.

Update Instance

Retrieve Instance Members

Update Instance Member Role

Delete Member from Instance

Returns the open (pending) RFI for this instance, or null if the instance has no pending RFI.

Submit a flat response object for the open instance RFI. Standalone: submitting does not change any instance or onboarding status. Returns { success: false, reason } when no pending RFI exists, callers should refetch the RFI state instead of retrying.

Returns a URL where the end customer accepts BlindPay's terms of service. A person must open it in a browser and accept; it cannot be accepted through the API. After acceptance the browser is sent to redirect_url with tos_id as a query parameter, and a tos.accept webhook fires. Pass that tos_id (to_...) to Create Customer. idempotency_key is any unique string and cannot be reused.

Retrieve Limit Increase Requests

Request Limit Increase

Retrieve Customers

Creates a customer and starts KYC (individuals) or KYB (businesses). Send the tos_id the customer received after accepting terms of service (see Initiate Terms of Service). Required fields depend on type and kyc_type. Individual, standard: first_name, last_name, date_of_birth, tax_id, address_line_1, city, state_province_region, postal_code, country, id_doc_country, id_doc_type, id_doc_front_file and selfie_file. Business, standard: legal_name, formation_date, tax_id, website, the same address fields, at least one entry in owners, incorporation_doc_file, proof_of_ownership_doc_file, proof_of_address_doc_type and proof_of_address_doc_file. kyc_type light is not available, and businesses only support standard. US state_province_region is a two-letter code. File fields are HTTPS URLs that BlindPay downloads, so they must be publicly fetchable; data: URIs are rejected. The customer starts with kyc_status verifying. Development instances approve it automatically.

Retrieve Customer

Update Customer

Delete Customer

Retrieve Customer Limits

Returns the open (pending) RFI for this customer, or null if the customer has no pending RFI.

Submit a flat response object for the open RFI. On success flips kyc_status back to verifying. Returns { success: false, reason } when no pending RFI exists, callers should refetch the RFI state instead of retrying.

Create Plaid Link

Retrieve Bank Accounts

Adds a payout destination for a customer. Required fields depend on type (the rail): call Bank Details (GET /v1/available/bank-details) with the rail first for the exact field list and validation. For ach and wire: business_industry (a NAICS code from GET /v1/available/naics) is required when account_class is business, phone_number is required when country is BR, CN, CO, HK, MY, MX, PH, UG or UY, and tax_id is required when country is AR, BY, BR, CL, CN, CO, CR, EC, GT, HN, JP, KZ, KR, MX, PK, PE, PH, RU, TH or UY. A US state_province_region is a two-letter code. ach, wire and rtp are not available for light KYC customers.

Retrieve Bank Account

Remove Bank Account

Retrieve Virtual Accounts

Creates a virtual account that automatically converts inbound USD deposits (ACH, wire, RTP) into stablecoins sent to the linked wallet. Fees on these automated payins depend on the deposit amount: deposits below $100.00 accrue the BlindPay fee to your billing cycle (charged at the end of the month via the payin's billing_fee_amount), while deposits of $100.00 or more are charged at the time of the transaction (deducted from the delivered amount via transaction_fee_amount). Every deposit is processed regardless of size and always delivers at least $0.01 on-chain; a partner fee (optional partner_fee_id) is collected only from what remains after that.

Retrieve Virtual Account

Update Virtual Account

Retrieve Blockchain Wallet Message

Retrieve Blockchain Wallets

Add Blockchain Wallet

Retrieve Blockchain Wallet

Remove Blockchain Wallet

Declares whether the customer holds the private keys of this wallet. Only works while is_self_custody is null; once saved it cannot be changed.

Get Offramp Wallets

Create Offramp Wallet

Get Offramp Wallet

Prices a payout. Send exactly one of bank_account_id or payable_id. request_amount is in cents (1000 means 10.00) and currency_type says whether it is what the sender pays or what the receiver gets. The quote expires 5 minutes after creation (expires_at is epoch milliseconds) and is single-use: execute it with Create Payout on EVM Chains for BlindPay-managed wallets on any network, Solana included, or with the Solana or Stellar payout endpoints for self-custodied wallets.

Get FX Rate

Retrieve Payout

Retrieve Payouts

Authorize Token Stellar

Create Payout on Stellar

Create Payout on Solana

Executes a payout quote. Despite the name, this is the endpoint for payouts funded from a BlindPay-managed wallet on any network, Solana included; self-custodied EVM wallets must approve the token first. Execute before the quote expires (5 minutes). Send an Idempotency-Key header so a retry cannot create a second payout. On development instances the payout completes on its own; request_amount 66600 makes it fail and 77700 makes it refunded.

Submit a compliance document for a payout. SWIFT payouts waiting for documents require it and the submission resumes the compliance review; the optional payment description is written to the SWIFT memo. Other rails (wire, ACH, RTP, Pix and so on) may attach an optional document while the payout is processing or completed. It is stored for compliance without changing the payout status or tracking, the description is ignored, and submitting again replaces the previous document.

Prices a payin from a local payment method into a stablecoin wallet. Send one of wallet_id (BlindPay-managed wallet) or blockchain_wallet_id. Do not send a network: the wallet decides where the tokens are delivered. request_amount is in cents; the minimum depends on the currency (1000, which is 10.00, for USD and BRL) and OTC quotes have a higher minimum. funding_bank_account_id is required when payment_method is ach_pull. The quote expires 5 minutes after creation, or 10 seconds for OTC quotes; create the payin with Create Payin before then.

Get FX Rate

Retrieve Payin

Retrieve Payins

Creates a payin from a payin quote and returns the instructions the payer uses to send funds (for example a Pix code or bank details). Create it before the payin quote expires. Send an Idempotency-Key header so a retry cannot create a second payin. On development instances the payin completes on its own about 30 seconds after creation; request_amount 66600 makes it fail and 77700 makes it refunded.

Submit Card Payment

Retrieve Wallets

Create Wallet

Retrieve Wallet

Remove Wallet

Returns the balance of a BlindPay-managed wallet for USDC, USDT and USDB. Unlike quote and payout amounts, these values are whole tokens, not cents: amount 10.5 means 10.5 USDC. total_amount is amount plus earning_amount from yield.

Incoming stablecoin deposits to a managed wallet, newest first.

Turns yield on for the wallet. Returns the wallet, not the yield object: read yield_status here and use Retrieve Wallet Yield for positions. Idle balance is swept into the vault within the hour.

Turns yield off for the wallet. Returns the wallet, not the yield object. The wallet moves to disabling, the vault position is redeemed back to the wallet and any accrued fee is collected, then yield_status settles to disabled and a wallet.update webhook fires.

Retrieve Wallet Yield History

Retrieve Wallet Yield Transactions

Retrieve Wallet Yield

Create Transfer Quote

Retrieve Transfer

Retrieve Transfers

Create Transfer

List Payables

Create Payable

Retrieve Payable

Delete Payable

Retrieve Webhooks

Registers an HTTPS endpoint that receives the listed events. Event names and payload schemas are in the webhooks section of this API reference (and in the MCP resource blindpay://webhooks/events). Deliveries are signed with Svix; read the signing secret with Retrieve Webhook Secret and verify every delivery.

Remove Webhook

Retrieve Webhook Secret

Retrieve Webhook Portal Access

Get all fees for an instance, sorted by payment method (fiat first, then blockchain)

Retrieve Partner Fees

Add Partner Fee

Retrieve Partner Fee

Remove Partner Fee

Presign File URL

Returns the fields a bank account needs for a payout rail, so a recipient form can collect and validate them before calling create bank account. Each field has a label, the request body key to send it under, a validation regex, and, where the value comes from a fixed list (banks, countries, account types), the allowed items. Get valid rail values from GET /v1/available/rails. Public: no API key required.

Lists every payout rail BlindPay supports (ACH, domestic wire, RTP, PIX, SPEI, SEPA, SWIFT, and more) as { label, value, country }. Pass value as the rail query parameter of GET /v1/available/bank-details, and as the type when creating a bank account. country is an ISO 3166-1 alpha-2 flag hint for display, not a statement of coverage. Public: no API key required.

NAICS list

Swift code bank details

Mint USDB on Solana

Prepares a delegation transaction for Solana token transfers. You can either provide a quote_id (recommended) to automatically use the correct token amount and address from the quote, or manually provide owner_address, token_address, and amount.

Create Asset Trustline

Mint USDB on Stellar