Payins

Methods for managing payin transactions

The Payins resource provides methods to create and manage incoming payments from fiat to crypto. Payins support multiple payment methods including ACH, Wire, PIX (Brazil), SPEI (Mexico), Transfers (Argentina), and PSE (Colombia).

list

Retrieve a list of all payins for your instance.

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

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

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.

status · 'refunded' | 'processing' | 'completed' | 'failed' | 'on_hold'

Filter payins by transaction status.

receiver_id · string

Filter payins by blockchain wallet receiver ID.

Response

data · Payin[]

Array of payin objects.

id · string

Unique identifier for the payin.

receiver_id · string

ID of the blockchain wallet receiving the funds.

status · 'refunded' | 'processing' | 'completed' | 'failed' | 'on_hold'

Current status of the payin transaction.

payin_quote_id · string

ID of the quote used for this payin.

instance_id · string

Your BlindPay instance ID.

payment_method · 'ach' | 'wire' | 'pix' | 'spei' | 'transfers' | 'pse'

Payment method used for the transaction.

sender_amount · number

Amount sent in fiat currency.

receiver_amount · number

Amount received in stablecoin.

token · 'USDC' | 'USDT' | 'USDB'

Stablecoin token received.

network · Network

Blockchain network for the transaction. Supported networks: base, sepolia, arbitrum_sepolia, base_sepolia, arbitrum, polygon, polygon_amoy, ethereum, stellar, stellar_testnet, tron, solana, solana_devnet.

currency · 'BRL' | 'USD' | 'MXN' | 'COP' | 'ARS'

Fiat currency used for the payin.

commercial_quotation · number

Commercial exchange rate applied.

blindpay_quotation · number

BlindPay exchange rate applied.

partner_fee_amount · number | null

Partner fee amount if applicable.

total_fee_amount · number | null

Total fees charged for the transaction.

type · 'individual' | 'business'

Account type of the payer.

name · string

Name of the payer.

first_name · string | null

First name of the payer (individual accounts).

last_name · string | null

Last name of the payer (individual accounts).

legal_name · string | null

Legal name of the payer (business accounts).

pix_code · string | null

PIX code for Brazilian payments.

memo_code · string | null

Memo code for certain payment methods.

clabe · string | null

CLABE number for Mexican SPEI payments.

blindpay_bank_details · BlindpayBankDetails | null

Bank account details for wire/ACH payments.

pse_payment_link · string | null

Payment link for PSE payments (Colombia).

tracking_transaction · PayinTrackingTransaction

Transaction tracking information.

tracking_payment · PayinTrackingPayment

Payment tracking information.

tracking_complete · PayinTrackingComplete

Completion tracking information.

tracking_partner_fee · PayinTrackingPartnerFee

Partner fee tracking information.

created_at · string

ISO 8601 timestamp of when the payin was created.

updated_at · string

ISO 8601 timestamp of when the payin 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 payin transaction.

const response = await blindpay.payins.get('payin_1234567890');

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

Parameters

payinId · string · required

The unique identifier of the payin to retrieve.

Response

data · Payin

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

getTrack

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

const response = await blindpay.payins.getTrack('payin_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_complete);
}

Parameters

payinId · string · required

The unique identifier of the payin to track.

Response

data · Payin

The payin object with tracking details.

createEvm

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

const response = await blindpay.payins.createEvm('pqt_1234567890');

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

Parameters

payin_quote_id · string · required

The ID of the payin quote to use for creating the transaction.

Response

data · CreateEvmPayinResponse

The created payin details.

id · string

Unique identifier for the created payin.

status · 'refunded' | 'processing' | 'completed' | 'failed' | 'on_hold'

Current status of the payin.

blindpay_bank_details · BlindpayBankDetails

Bank account details where the payer should send funds.

routing_number · string

Bank routing number.

account_number · string

Bank account number.

account_type · string

Type of bank account.

swift_bic_code · string | null

SWIFT/BIC code for international transfers.

ach · object | null

ACH-specific routing and account numbers.

wire · object | null

Wire-specific routing and account numbers.

rtp · object | null

RTP-specific routing and account numbers.

beneficiary · object

Beneficiary information including name and address.

pix_code · string | null

PIX code for Brazilian payments.

memo_code · string | null

Memo code for certain payment methods.

clabe · string | null

CLABE number for Mexican SPEI payments.

receiver_id · string | null

ID of the blockchain wallet receiving the funds.

receiver_amount · number | null

Amount to be received in stablecoin.

sender_amount · number | null

Amount to be sent in fiat currency.

payment_method · 'ach' | 'wire' | 'pix' | 'spei' | 'transfers' | 'pse' | null

Payment method for the transaction.

billing_fee · number | null

Billing fee for the transaction.

tracking_transaction · PayinTrackingTransaction

Transaction tracking information.

tracking_payment · PayinTrackingPayment

Payment tracking information.

tracking_complete · PayinTrackingComplete

Completion tracking information.

tracking_partner_fee · PayinTrackingPartnerFee

Partner fee tracking information.