Get Order Details¶

Overview¶

Use the GetOrderDetails endpoint to retrieve detailed information about a specific order.

Endpoint¶

POST https://api.brij.fi/brij.core.v1.partner.Service/GetOrderDetails

Request Body¶

{
  "orderId": "order_abc123"
}

Request Parameters¶

Field	Type	Required	Description
`orderId`	string	Yes	Unique identifier for the order

Response¶

{
  "order": {
    "id": "order_abc123",
    "customerId": "cust_xyz789",
    "externalId": "ext_123",
    "partnerId": "partner_456",
    "status": "AWAITING_FUNDS",
    "sourceCurrency": "USD",
    "sourceAmount": "100.00",
    "destinationCurrency": "SOLANA_SOL",
    "destinationAmount": "1.5234",
    "transactionType": "ONRAMP",
    "network": "SOLANA",
    "depositInstructions": {
      "bankName": "Example Bank",
      "accountNumber": "1234567890",
      "routingNumber": "021000021"
    },
    "customerPaymentDetailsDataId": "data_bank123",
    "customerWalletDataId": "data_wallet456",
    "paymentMethod": "USA_ACH",
    "createdAt": "2025-01-15T10:30:00Z",
    "updatedAt": "2025-01-15T10:30:00Z"
  }
}

Response Parameters¶

Field	Type	Description
`order`	object	The order details

Order Object¶

Field	Type	Description
`id`	string	Unique identifier for the order
`customerId`	string	Unique identifier for the customer
`externalId`	string	External reference ID
`partnerId`	string	Unique identifier for the partner
`status`	string	Current order status (see Order Statuses)
`sourceCurrency`	string	Source currency code (e.g., "USD", "SOLANA_SOL")
`sourceAmount`	string	Source amount as decimal string
`destinationCurrency`	string	Destination currency code (e.g., "SOLANA_SOL", "USD")
`destinationAmount`	string	Destination amount as decimal string
`transactionType`	string	Transaction type: `ONRAMP` or `OFFRAMP`
`network`	string	Blockchain network (e.g., "SOLANA", "ETHEREUM")
`depositInstructions`	object	Payment instructions for the customer (see below)
`customerPaymentDetailsDataId`	string	Data ID for customer's payment details (e.g., bank account)
`customerWalletDataId`	string	Data ID for customer's crypto wallet
`sourceTransactionId`	string	Transaction ID for the source transaction
`destinationTransactionId`	string	Transaction ID for the destination transaction
`paymentMethod`	string	Payment method code (e.g., "USA_ACH", "EUR_SEPA")
`reason`	string	Reason for error or cancellation (only for error/canceled orders)
`returnDetails`	object	Details about returned funds (if applicable)
`createdAt`	string	ISO 8601 timestamp when the order was created
`updatedAt`	string	ISO 8601 timestamp when the order was last updated

Order Statuses¶

Value	Description
`AWAITING_FUNDS`	Waiting for customer to send funds
`FUNDS_RECEIVED`	Funds received from customer
`PAYMENT_SUBMITTED`	Payment submitted to destination
`PAYMENT_PROCESSED`	Payment completed successfully (terminal status)
`REFUNDING`	Refund in progress
`REFUNDED`	Refund complete (terminal status)
`CANCELED`	Canceled by customer (terminal status)
`ERROR`	Error occurred (terminal status)
`IN_REVIEW`	Under compliance/AML review (temporary status)

Transaction Types¶

Value	Description
`ONRAMP`	Fiat to Crypto
`OFFRAMP`	Crypto to Fiat

DepositInstructions Object¶

Instructions for the customer to deposit funds. Fields vary based on payment method.

Field	Type	Description
`paymentMethod`	string	Payment method code
`network`	string	Blockchain network (for crypto deposits)
`amount`	string	Amount to deposit
`currency`	string	Currency code
`fromAddress`	string	Source address (for crypto)
`toAddress`	string	Destination address (for crypto)
`depositMessage`	string	Message/memo to include with deposit
`bankName`	string	Bank name (for fiat deposits)
`bankAddress`	string	Bank address
`bankRoutingNumber`	string	Bank routing number (US)
`bankAccountNumber`	string	Bank account number
`bankBeneficiaryName`	string	Beneficiary name on bank account
`bankBeneficiaryAddress`	string	Beneficiary address
`iban`	string	IBAN (international bank account)
`bic`	string	BIC/SWIFT code
`clabe`	string	CLABE (Mexico)
`accountHolderName`	string	Account holder name
`blockchainMemo`	string	Blockchain memo/tag (for networks that require it)

ReturnDetails Object¶

Details about returned/refunded funds.

Field	Type	Description
`reason`	string	Reason for the return
`refundReferenceId`	string	Reference ID for the refund

Error Responses¶

Status Code	Description
`400`	Invalid request parameters
`401`	Invalid or missing API key
`404`	Order or partner not found
`500`	Internal server error

Examples¶

Example 1: Get Order Details¶

Retrieve details for a specific order:

{
  "orderId": "order_abc123"
}