Sign in
Payins

Retrieve Payin

get/v1/instances/{instance_id}/payins/{id}

Path parameters

instance_idstring required
Example:in_000000000000
idstring required
Example:pi_000000000000

Response

List payins

idstring required
pix_codestring nullable

PIX code

memo_codestring nullable

Memo code

clabestring nullable

CLABE code

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

Payin general status

payin_quote_idstring required
instance_idstring required
customer_idstring required
partner_feeinteger

Payin partner fee amount in cents

manual_execution_status'pending' | 'concluded' | 'failed' nullable

When non-null, the payin was created while the manual OTC liquidity toggle was ON. pending means an operator must convert BRL→USDT manually and click "Mark concluded"; concluded closes the internal flow. Customer-facing behavior is identical in either mode.

{"stackTrail":"components:schemas:PayinOut:properties:manual_concluded_at","oasType":"schema","type":"unknown","description":"When `manual_execution_status` transitioned to `concluded`. Postgres returns a Date; this transform normalizes to an ISO string for the SDK.","example":null}
manual_concluded_bystring nullable

Identifier of the operator who marked the manual OTC concluded.

created_atstring date-time nullable
updated_atstring date-time nullable
image_urlstring uri nullable
first_namestring nullable
last_namestring nullable
legal_namestring nullable
type'individual' | 'business' required
payment_method'ach' | 'wire' | 'pix' | 'ted' | 'spei' | 'transfers' | 'pse' | 'international_swift' | 'rtp' required
sender_amountnumber nullable required

52.40 BRL needs to be sent in a pix transfer

receiver_amountnumber nullable required

10.10 USDC

token'USDC' | 'USDT' | 'USDB' required
partner_fee_idstring nullable
partner_fee_amountnumber nullable

1.5 USDC

total_fee_amountnumber nullable

1.53 USDC

commercial_quotationnumber nullable required

1 USD = 4.95 BRL

blindpay_quotationnumber nullable required

1 USD = 5.05 BRL (commercial quotation + (blindpay taxes))

currency'BRL' | 'USD' | 'MXN' | 'COP' | 'ARS' | 'EUR' required

ISO 4271 currency code

billing_fee_amountnumber nullable

BlindPay fee in cents accrued to your billing cycle (charged at the end of the month). Virtual account deposits below $100.00 always accrue here, so small deposits are delivered in full.

transaction_fee_amountnumber nullable

BlindPay fee in cents deducted from the transaction at the time it is processed. Virtual account deposits of $100.00 or more are charged here (unless your instance is configured for end-of-month billing, in which case every fee accrues to billing_fee_amount).

is_otcboolean nullable

If true, the payin quote is for an OTC (Over the Counter) transaction

namestring required
addressstring nullable
network'base' | 'sepolia' | 'arbitrum_sepolia' | 'base_sepolia' | 'arbitrum' | 'polygon' | 'polygon_amoy' | 'ethereum' | 'stellar' | 'stellar_testnet' | 'tron' | 'solana' | 'solana_devnet' | 'tempo' | 'tempo_testnet' required
pse_payment_linkstring nullable

PSE payment link (derived from tracking_transaction.pse_instruction)

pse_full_namestring nullable

PSE payer full name

pse_tax_idstring nullable

PSE payer document number

pse_document_type'CC' | 'NIT' nullable

PSE payer document type

Example response

{
  "id": "re_000000000000",
  "pix_code": "00020101021226790014br.gov.bcb.pix2557brcode.starkinfra.com/v2/bcf07f6c4110454e9fd6f120bab13e835204000053039865802BR5915Blind Pay, Inc.6010Vila Velha62070503***6304BCAB",
  "memo_code": "8K45GHBNT6BQ6462",
  "clabe": "014027000000000008",
  "status": "processing",
  "payin_quote_id": "pq_000000000000",
  "instance_id": "in_000000000000",
  "customer_id": "re_000000000000",
  "partner_fee": 25000,
  "tracking_transaction": {
    "step": "processing",
    "status": "failed",
    "external_id": "12345678",
    "completed_at": "2011-10-05T14:48:00.000Z",
    "transaction_hash": "0x123...890",
    "provider_name": "HSBC",
    "provider_transaction_id": "<provider_transaction_id>",
    "sender_name": "John Doe Smith",
    "sender_bank_name": "Bank of America",
    "sender_tax_id": "123.456.789-10",
    "sender_bank_code": "00416968",
    "sender_account_number": "1234567890",
    "end_to_end_id": "E20018183202603311320vm6ALFpJpsS",
    "trace_number": "1234567890",
    "transaction_reference": "1234567890",
    "description": "Payment from John Doe Smith",
    "pse_instruction": {
      "payment_link": "https://pse.example.com/payment/abc123",
      "fid": "fid_abc123",
      "full_name": "Juan Pérez García",
      "tax_id": "1234567890",
      "document_type": "CC",
      "phone": "+573001234567",
      "email": "juan@example.com",
      "bank_code": "1007"
    },
    "transfers_instruction": {
      "account": "0000003100012389237485",
      "type": "CVU",
      "tax_id": "20123456783"
    },
    "ted_instruction": {
      "beneficiary_name": "Blind Pay, Inc.",
      "tax_id": "57.599.376/0001-81",
      "bank_code": "665",
      "bank_name": "STARK BANK S.A.",
      "branch_code": "5340",
      "account_number": "01011707084-8",
      "account_type": "checking"
    }
  },
  "tracking_payment": {
    "step": "on_hold",
    "provider_name": "blockchain",
    "completed_at": "2011-10-05T14:48:00.000Z",
    "review_source": "seon_review",
    "review_sources": [
      "seon_review",
      "new_instance"
    ],
    "approved_risk_sources": [
      "seon_review"
    ]
  },
  "tracking_complete": {
    "step": "on_hold",
    "transaction_hash": "0x123...890",
    "completed_at": "2011-10-05T14:48:00.000Z"
  },
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "image_url": "https://example.com/image.png",
  "first_name": "John",
  "last_name": "Doe",
  "legal_name": "Company Name Inc.",
  "type": "individual",
  "payment_method": "pix",
  "sender_amount": 5240,
  "receiver_amount": 1010,
  "token": "USDC",
  "partner_fee_id": "pf_000000000000",
  "partner_fee_amount": 150,
  "total_fee_amount": 1.53,
  "commercial_quotation": 495,
  "blindpay_quotation": 505,
  "currency": "BRL",
  "billing_fee_amount": 50,
  "transaction_fee_amount": 100,
  "payer_rules": {
    "pix_allowed_tax_ids": [
      "123.456.789-09"
    ],
    "transfers_allowed_tax_id": "20-12345678-3",
    "pse_allowed_tax_ids": [
      "1234567890"
    ]
  },
  "name": "Wallet Display Name",
  "address": "0xDD6a3aD0949396e57C7738ba8FC1A46A5a1C372C",
  "network": "polygon",
  "blindpay_bank_details": {
    "routing_number": "121145349",
    "account_number": "621327727210181",
    "account_type": "Business checking",
    "swift_bic_code": "CHASUS33",
    "ach": {
      "routing_number": "123456789",
      "account_number": "123456789"
    },
    "wire": {
      "routing_number": "123456789",
      "account_number": "123456789"
    },
    "rtp": {
      "routing_number": "123456789",
      "account_number": "123456789"
    },
    "beneficiary": {
      "name": "BlindPay, Inc.",
      "address_line_1": "8 The Green, #19364",
      "address_line_2": "Dover, DE 19901"
    },
    "receiving_bank": {
      "name": "CFSB",
      "address_line_1": "1 Letterman Drive, Building A, Suite A4-700",
      "address_line_2": "San Francisco, CA 94129"
    },
    "swift_account_number": "GB50TCCL04140449730892",
    "swift_receiving_bank": {
      "name": "JPMorgan Chase",
      "address_line_1": "270 Park Ave",
      "address_line_2": "New York, NY, 10017-2070"
    }
  },
  "pse_payment_link": "https://pse.example.com/payment/abc123",
  "pse_full_name": "Juan Pérez García",
  "pse_tax_id": "1234567890",
  "pse_document_type": "CC"
}

Changes

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