Skip to Content
BrazilPayinGet Pay-in Status (Brazil PIX)

Get Pay-in Status (Brazil PIX)

GET/v1/payins/:id

Poll pay-in status after Create Pay-in. This is the shared status endpoint for all rails — use the transactionId from the Brazil create response. There is no request body.

Path parameters

FieldTypeRequiredDescription
idstringYesUse transactionId from the create response

Example

curl -X GET https://api.transacty.ai/v1/payins/{transactionId} \
  -H "X-Transacty-Key: $TRANSACTY_KEY" \
  -H "X-Transacty-Timestamp: $TS" \
  -H "X-Transacty-Signature: $SIG" \
  -H "Content-Type: application/json"

Response fields

FieldTypeDescription
idstringInternal id (same as transactionId)
transactionIdstringPublic transaction id
statusstringpending, success, or failed
amountstringRequested pay-in amount
paidAmountstring | nullAmount the customer paid; set on success
currencystringBRL
platformOrderIdstringProvider-side order reference
paymentMethodstringPIX
createdAtstring (ISO datetime)Creation timestamp
completedAtstring | null (ISO datetime)Completion timestamp; null while pending
feesobjectTransacty service fee
fees.platformFeestringService fee amount
fees.feeTypestringpayin
fees.feeStatusstringestimated while pending; applied on success
netAmountstringBRL credited to your wallet after the fee
totalWalletDebitstring | nullnull on pay-in

Reconcile on the webhook (payin.completed) or by polling until status === "success". Brazil transactions also appear on GET /v1/transactions with rail: "brazil".

Next steps

Last updated on