Skip to main content
GET
Busca ordem de payin

Authorizations

x-api-key
string
header
required
x-api-secret
string
header
required

Path Parameters

id
string<uuid>
required

Response

OK

id
string<uuid>
required
merchantId
string<uuid>
required
receiverId
string<uuid>
required
type
enum<string>
required
Available options:
PAYIN,
PAYOUT
status
enum<string>
required
Available options:
PENDING,
AWAITING_PAYMENT,
PAYMENT_RECEIVED,
SWAPPING,
TRANSFERRING,
AWAITING_DEPOSIT,
DEPOSIT_RECEIVED,
PIX_SENDING,
PIX_SENT_UNCONFIRMED,
COMPLETED,
FAILED,
EXPIRED,
REFUNDING,
REFUNDED
chain
string
required
Example:

"solana"

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
externalId
string | null

ID do merchant para rastreamento interno.

receiverName
string | null
merchantName
string | null
amountBrl
number | null
Example:

1000

amountCrypto
number | null
Example:

199.5

targetToken
string | null

Payin only. Token que o receiver recebe (ex: USDC).

Example:

"USDC"

sourceToken
string | null

Payout only. Token que o receiver envia (ex: USDC).

Example:

"USDC"

destinationWallet
string | null

Payin only. Endereço Solana onde o crypto é entregue.

Example:

"4k5dSo1EnderecoSolana..."

depositAddress
string | null

Payout only. Endereço Solana para onde o receiver deve enviar o crypto.

Example:

"7xMnSo2EnderecoDeposito..."

paymentReference
string | null

Payout only. PublicKey Solana não custodial (sem chave privada, sem saldo) usada como reference no padrão Solana Pay para correlacionar o depósito on-chain a esta order. Inclua essa pubkey como account read-only e não-signer na sua transação SPL Transfer — sem isso, a plataforma não consegue identificar que o depósito pertence a este payout e a order expira em AWAITING_DEPOSIT.

exchangeRate
number | null

Taxa de câmbio utilizada na ordem (BRL/token).

Example:

5.01

feePercentage
number | null

Percentual total de taxa aplicado.

Example:

2.5

netAmountBrl
number | null

Valor BRL líquido após taxas.

Example:

975

amountUsdc
number | null
Example:

194.61

amountToken
number | null

Quantidade final do token entregue.

Example:

194.61

platformFeePercentage
number | null
Example:

1.5

platformFeeAmountBrl
number | null
Example:

15

merchantFeePercentage
number | null
Example:

1

merchantFeeAmountBrl
number | null
Example:

10

pixPaymentCode
string | null

Payin only. Código EMV copia-e-cola do PIX.

Example:

"00020126..."

pixKey
string | null

Payout only. Chave PIX do destinatário.

pixKeyType
enum<string> | null

Payout only. Tipo da chave PIX.

Available options:
CPF,
CNPJ,
PHONE,
EMAIL,
RANDOM,
QRCODE
recipientName
string | null

Payout only. Nome do destinatário no PIX.

failureReason
string | null

Motivo da falha, preenchido quando status=FAILED.

expiresAt
string<date-time> | null
completedAt
string<date-time> | null
transactions
object[]

Transações associadas à ordem (on-chain e PIX).