GetOrders | Brij | Documentation

curl -X POST https://api-demo.brij.fi/brij.core.v1.partner.Service/GetOrders \
     -H "X-API-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "status": "AWAITING_FUNDS"
}'

{
  "orders": [
    {
      "id": "order_1234567890abcdef",
      "customerId": "cust_9876543210fedcba",
      "externalId": "ext_20240601_001",
      "partnerId": "partner_abc123",
      "status": "AWAITING_FUNDS",
      "sourceCurrency": "USD",
      "sourceAmount": "1500.00",
      "destinationCurrency": "BTC",
      "destinationAmount": "0.035",
      "transactionType": "ONRAMP",
      "network": "BITCOIN",
      "depositInstructions": {
        "paymentMethod": "USD_WIRE",
        "network": "SWIFT",
        "amount": "1500.00",
        "currency": "USD",
        "fromAddress": "",
        "toAddress": "",
        "depositMessage": "Deposit for order order_1234567890abcdef",
        "bankName": "First National Bank",
        "bankAddress": "123 Bank St, New York, NY 10001",
        "bankRoutingNumber": "021000021",
        "bankAccountNumber": "987654321",
        "bankBeneficiaryName": "Brij Partner Account",
        "bankBeneficiaryAddress": "456 Partner Ave, San Francisco, CA 94105",
        "iban": "US64FNBB12345678901234",
        "bic": "FNBBUS33",
        "clabe": "",
        "accountHolderName": "Brij Partner Account",
        "blockchainMemo": ""
      },
      "customerPaymentDetailsDataId": "paydet_0011223344",
      "customerWalletDataId": "wallet_5566778899",
      "sourceTransactionId": "",
      "destinationTransactionId": "",
      "paymentMethod": "USD_WIRE",
      "reason": "",
      "createdAt": "2024-06-01T10:15:30Z",
      "updatedAt": "2024-06-01T10:20:00Z"
    },
    {
      "id": "order_abcdef1234567890",
      "customerId": "cust_1234567890abcdef",
      "externalId": "ext_20240601_002",
      "partnerId": "partner_xyz789",
      "status": "AWAITING_FUNDS",
      "sourceCurrency": "EUR",
      "sourceAmount": "2000.00",
      "destinationCurrency": "ETH",
      "destinationAmount": "1.25",
      "transactionType": "ONRAMP",
      "network": "ETHEREUM",
      "depositInstructions": {
        "paymentMethod": "EUR_SEPA",
        "network": "SEPA",
        "amount": "2000.00",
        "currency": "EUR",
        "fromAddress": "",
        "toAddress": "",
        "depositMessage": "Deposit for order order_abcdef1234567890",
        "bankName": "Deutsche Bank",
        "bankAddress": "Taunusanlage 12, 60325 Frankfurt am Main, Germany",
        "bankRoutingNumber": "50070024",
        "bankAccountNumber": "1234567890",
        "bankBeneficiaryName": "Brij Partner Account",
        "bankBeneficiaryAddress": "789 Partner Blvd, Berlin, Germany",
        "iban": "DE89370400440532013000",
        "bic": "DEUTDEFF",
        "clabe": "",
        "accountHolderName": "Brij Partner Account",
        "blockchainMemo": ""
      },
      "customerPaymentDetailsDataId": "paydet_9988776655",
      "customerWalletDataId": "wallet_1122334455",
      "sourceTransactionId": "",
      "destinationTransactionId": "",
      "paymentMethod": "EUR_SEPA",
      "reason": "",
      "createdAt": "2024-06-01T11:00:00Z",
      "updatedAt": "2024-06-01T11:05:00Z"
    }
  ],
  "totalCount": 2
}

Retrieve a list of orders for your partner integration. You can optionally filter orders by status.

Authentication

X-API-Keystring

API Key authentication via header

Request

This endpoint expects an object.

statusenumOptional

Optional status filter

Response

Success

orderslist of objects or null

totalCountinteger or null