Partners

Create Payout to a Crypto Wallet Address

Execute a payout to a specified crypto wallet address. Create a transaction to transfer funds from the account to an external crypto wallet address. This endpoint facilitates outbound payments in supported cryptocurrencies while maintaining transaction security and tracking.

post/partners/accounts/{account_ref}/payout/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/payout/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

amountstring required

ccystring required

chain_idinteger required

referencestring

token_addressstring

wallet_addressstring required

Response

amountstring

amount

created_atstring

created_at

currencystring

currency

customer_idstring

customer_id

idstring

invoice_idstring

invoice_id

next_actionstring

next_action

org_idstring

org_id

parent_idstring

parent_id

payment_method1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11

The payment method:

1 = Unknown
2 = Merchantcontract
3 = Proxywallet
4 = Unblock
5 = Card
6 = Googlepay
7 = Applepay
8 = Paypal
9 = Directdebit
10 = Ramp
11 = Rampcryptosettlement

propertiesobject

scheduled_timeinteger

scheduled_time

source1 | 2 | 3 | 4

The source of this billing information. Can be one of the following:

1 = Lago
2 = Boomfi
3 = Stripe
4 = Chargebee

status1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

The current status of the payment_id:

1 = Unknown
2 = Requirespaymentmethod
3 = Requiresconfirmation
4 = Requiresaction
5 = Processing
6 = Succeeded
7 = Canceled
8 = Failed

updated_atstring

updated_at

Changes

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