GET

Check Specific Payout

Returns one payout created through the API, by the internal_reference returned when it was created.

status is pending, completed, failed or refunded, and txid is null while there is no transaction hash. crypto_amount is the net amount sent to the wallet. A payout made in the panel, or belonging to another account, returns 404.

GEThttps://bridge.bifrostcrypto.com/v1/check-payout/{internal_reference}

Required scope:payout:read(a new key with no list is read-only)

Headers

Key	Value	Description
`X-Bifrost-Invoke`	`{{api_key}}`	Private API key

Path Parameters

Parameter	Example	Description
`{internal_reference}`	`f47ac10b-58cc-4372-a567-0e02b2c3d479`	internal_reference of the payout (a UUID). Fewer than 10 or more than 756 characters returns invalid_reference_id.

cURL Example

bash

curl -X GET "https://bridge.bifrostcrypto.com/v1/check-payout/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "X-Bifrost-Invoke: YOUR_API_KEY"

Response Example

json

{
  "message": "payment_retrieved_success",
  "payment": {
    "internal_reference": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "reference_id": "order_12345",
    "wallet": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb0",
    "crypto_currency": "USDT",
    "fiat_currency": "USD",
    "crypto_amount": "100.500000000000000000",
    "fiat_amount": "100.50",
    "process_by": "crypto_amount",
    "percent_rate": "1.50",
    "network_fee": "0.00100000",
    "network": "Ethereum",
    "status": "completed",
    "txid": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060",
    "webhook_url": "https://your-site.com/webhook",
    "feetakenfromamount": "0",
    "created_at": "2026-01-16 10:00:00",
    "updated_at": "2026-01-16 10:05:00"
  }
}

Errors

Every error has the shape error.code, error.message and, when useful, error.details. Authentication, scope and rate-limit errors (401, 403, 429) apply to every endpoint and are described under Authentication.

Status	Code	When	What to do
400	`invalid_reference_id`	internal_reference is shorter than 10 or longer than 756 characters.	Fix the request before sending it again.
404	`record_not_found`	No payout created through the API with this internal_reference exists on your account.	Check the internal_reference returned on creation. Items created in the panel are not returned.

Other responses

Responses that are not the happy path and still need handling in your integration.

404

Payout not found

No payout created through the API with this internal_reference exists on your account.

json

{
  "error": {
    "code": "record_not_found",
    "message": "Record not found",
    "details": {
      "resource": "payment"
    }
  }
}

400

Invalid reference

The internal_reference is shorter than 10 or longer than 756 characters.

json

{
  "error": {
    "code": "invalid_reference_id",
    "message": "Invalid reference ID provided"
  }
}