Payouts - BlindPay Node.js SDK

The Payouts resource provides methods to create and manage outgoing payments from crypto to fiat. Payouts support multiple blockchain networks (Stellar, EVM chains, Solana) and various fiat payment rails.

list

Retrieve a list of all payouts for your instance.

const response = await blindpay.payouts.list({
  limit: '50',
  offset: '0',
  receiver_id: 'rcv_1234567890'
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(response.data.data);
  console.log(response.data.pagination);
}

Parameters

limit

'10' | '50' | '100' | '200' | '1000'

Number of results to return per page.

offset

'0' | '10' | '50' | '100' | '200' | '1000'

Number of results to skip.

starting_after

string

Cursor for pagination. Returns results after this cursor.

ending_before

string

Cursor for pagination. Returns results before this cursor.

receiver_id

string

Filter payouts by receiver (beneficiary) ID.

Response

data

Payout[]

Array of payout objects.

string

Unique identifier for the payout.

receiver_id

string

ID of the beneficiary receiving the funds.

status

'refunded' | 'processing' | 'completed' | 'failed' | 'on_hold'

Current status of the payout transaction.

sender_wallet_address

string

Blockchain wallet address sending the stablecoins.

signed_transaction

string

Signed blockchain transaction.

quote_id

string

ID of the quote used for this payout.

instance_id

string

Your BlindPay instance ID.

network

Network

Blockchain network used. Supported: base, arbitrum, polygon, ethereum, stellar, tron, solana, and testnets.

token

'USDC' | 'USDT' | 'USDB'

Stablecoin token sent.

sender_amount

number

Amount sent in stablecoin.

receiver_amount

number

Amount received in fiat currency.

receiver_local_amount

number

Local amount received by the beneficiary.

currency

string

Fiat currency received (e.g., BRL, USD, MXN, COP, ARS).

commercial_quotation

number

Commercial exchange rate applied.

blindpay_quotation

number

BlindPay exchange rate applied.

partner_fee_amount

number

Partner fee amount charged.

total_fee_amount

number

Total fees charged for the transaction.

type

Rail

Payment rail used. Options: wire, ach, pix, spei_bitso, transfers_bitso, ach_cop_bitso, international_swift, rtp.

description

string

Transaction description.

name

string

Beneficiary name.

first_name

string

Beneficiary first name.

last_name

string

Beneficiary last name.

legal_name

string

Beneficiary legal name (for businesses).

account_class

'individual' | 'business'

Type of beneficiary account.

transaction_document_type

TransactionDocumentType

Type of supporting document. Options: invoice, purchase_order, delivery_slip, contract, customs_declaration, bill_of_lading, others.

transaction_document_file

string

URL or identifier of the transaction document.

transaction_document_id

string

Document ID for the transaction.

has_virtual_account

boolean

Whether the payout uses a virtual account.

tracking_transaction

PayoutTrackingTransaction

Blockchain transaction tracking information.

tracking_payment

PayoutTrackingPayment

Fiat payment tracking information.

tracking_liquidity

PayoutTrackingLiquidity

Liquidity provider tracking information.

tracking_complete

PayoutTrackingComplete

Completion tracking information.

tracking_partner_fee

PayoutTrackingPartnerFee

Partner fee tracking information.

created_at

string

ISO 8601 timestamp of when the payout was created.

updated_at

string

ISO 8601 timestamp of when the payout was last updated.

pagination

PaginationMetadata

Pagination information.

has_more

boolean

Whether there are more results available.

next_page

string

URL for the next page of results.

prev_page

string

URL for the previous page of results.

get

Retrieve details of a specific payout transaction.

const response = await blindpay.payouts.get('payout_1234567890');

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(response.data);
}

Parameters

payoutId

string

required

The unique identifier of the payout to retrieve.

Response

data

Payout

The payout object with all details (same structure as list response items).

getTrack

Retrieve tracking information for a payout transaction using an external endpoint that doesn’t require authentication.

const response = await blindpay.payouts.getTrack('payout_1234567890');

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(response.data.tracking_transaction);
  console.log(response.data.tracking_payment);
  console.log(response.data.tracking_liquidity);
  console.log(response.data.tracking_complete);
}

Parameters

payoutId

string

required

The unique identifier of the payout to track.

Response

data

Payout

The payout object with tracking details.

authorizeStellarToken

Authorize a Stellar token for use in payout transactions. This is required before creating Stellar payouts with certain tokens.

const response = await blindpay.payouts.authorizeStellarToken({
  quote_id: 'qt_1234567890',
  sender_wallet_address: 'GXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(`Transaction hash: ${response.data.transaction_hash}`);
}

Parameters

quote_id

string

required

ID of the payout quote.

sender_wallet_address

string

required

Stellar wallet address that will send the tokens.

Response

data

AuthorizeStellarTokenResponse

transaction_hash

string

Hash of the authorization transaction on Stellar.

createStellar

Create a payout transaction on the Stellar network.

const response = await blindpay.payouts.createStellar({
  quote_id: 'qt_1234567890',
  sender_wallet_address: 'GXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  signed_transaction: '...' // Optional pre-signed transaction
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(`Payout ID: ${response.data.id}`);
  console.log(`Status: ${response.data.status}`);
}

Parameters

quote_id

string

required

ID of the payout quote to execute.

sender_wallet_address

string

required

Stellar wallet address sending the stablecoins.

signed_transaction

string

Pre-signed Stellar transaction. If not provided, BlindPay will create and sign the transaction.

Response

data

CreateStellarPayoutResponse

string

Unique identifier for the created payout.

status

'refunded' | 'processing' | 'completed' | 'failed' | 'on_hold'

Current status of the payout.

sender_wallet_address

string

Stellar wallet address sending the funds.

receiver_id

string

ID of the beneficiary receiving the funds.

tracking_transaction

PayoutTrackingTransaction

Blockchain transaction tracking information.

tracking_payment

PayoutTrackingPayment

Fiat payment tracking information.

tracking_liquidity

PayoutTrackingLiquidity

Liquidity provider tracking information.

tracking_complete

PayoutTrackingComplete

Completion tracking information.

tracking_partner_fee

PayoutTrackingPartnerFee

Partner fee tracking information.

createEvm

Create a payout transaction on EVM-compatible blockchain networks (Ethereum, Base, Arbitrum, Polygon).

const response = await blindpay.payouts.createEvm({
  quote_id: 'qt_1234567890',
  sender_wallet_address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb'
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(`Payout ID: ${response.data.id}`);
  console.log(`Status: ${response.data.status}`);
}

Parameters

quote_id

string

required

ID of the payout quote to execute.

sender_wallet_address

string

required

EVM wallet address sending the stablecoins (must start with 0x).

Response

data

CreateEvmPayoutResponse

string

Unique identifier for the created payout.

status

'refunded' | 'processing' | 'completed' | 'failed' | 'on_hold'

Current status of the payout.

sender_wallet_address

string

EVM wallet address sending the funds.

receiver_id

string

ID of the beneficiary receiving the funds.

tracking_transaction

PayoutTrackingTransaction

Blockchain transaction tracking information.

tracking_payment

PayoutTrackingPayment

Fiat payment tracking information.

tracking_liquidity

PayoutTrackingLiquidity

Liquidity provider tracking information.

tracking_complete

PayoutTrackingComplete

Completion tracking information.

tracking_partner_fee

PayoutTrackingPartnerFee

Partner fee tracking information.

createSolana

Create a payout transaction on the Solana network.

const response = await blindpay.payouts.createSolana({
  quote_id: 'qt_1234567890',
  sender_wallet_address: 'ABC123...XYZ',
  signed_transaction: null // Or provide a pre-signed transaction
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(`Payout ID: ${response.data.id}`);
  console.log(`Status: ${response.data.status}`);
}

Parameters

quote_id

string

required

ID of the payout quote to execute.

sender_wallet_address

string

required

Solana wallet address sending the stablecoins.

signed_transaction

string | null

required

Pre-signed Solana transaction, or null if BlindPay should create and sign the transaction.

Response

data

CreateSolanaPayoutResponse

string

Unique identifier for the created payout.

status

'refunded' | 'processing' | 'completed' | 'failed' | 'on_hold'

Current status of the payout.

sender_wallet_address

string

Solana wallet address sending the funds.

receiver_id

string | null

ID of the beneficiary receiving the funds.

tracking_transaction

PayoutTrackingTransaction

Blockchain transaction tracking information.

tracking_payment

PayoutTrackingPayment

Fiat payment tracking information.

tracking_complete

PayoutTrackingComplete

Completion tracking information.

tracking_partner_fee

PayoutTrackingPartnerFee

Partner fee tracking information.

tracking_liquidity

PayoutTrackingLiquidity

Liquidity provider tracking information.

Documentation Index

​list

​Parameters

​Response

​get

​Parameters

​Response

​getTrack

​Parameters

​Response

​authorizeStellarToken

​Parameters

​Response

​createStellar

​Parameters

​Response

​createEvm

​Parameters

​Response

​createSolana

​Parameters

​Response

list

Parameters

Response

get

Parameters

Response

getTrack

Parameters

Response

authorizeStellarToken

Parameters

Response

createStellar

Parameters

Response

createEvm

Parameters

Response

createSolana

Parameters

Response