Partners

Create Permanent Pay-In Deposit Wallet for Account

Generate a permanent deposit wallet for account pay-ins. Create a dedicated pay-in wallet for an account. Funds deposited to this wallet are automatically swept into the main account. This enables seamless fund aggregation and reduces manual processing.

post/partners/accounts/{account_ref}/payin/address

Request

Base URL
//mapi.boomfi.xyz (relative, and the document’s source URL is not known)
Auth
- API key in header X-API-KEY
- or API key in header X-API-Signature
- or API key in header X-API-Nonce
TypeScript
https://skmtc.dev/boomfi/apis/boomfi-merchants-api/docs/partners/accounts/:account_ref/payin/address/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

account_refstring required

Your own account reference identifier.

Request body

chain_idinteger required

The blockchain network ID to create the deposit wallet on.

currencystring

Optional currency filter. If omitted, the deposit wallet accepts all currencies enabled on the parent account for this chain.

referencestring required

A unique reference for this deposit wallet, typically a customer identifier. Used to look up the wallet on subsequent calls.

Example request

{
  "chain_id": 137,
  "currency": "USDC",
  "reference": "customer-001"
}

Response

errorboolean

messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.