UpdateOrder | Brij | Documentation

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

{
  "order": {
    "id": "ord_9f8b7c6d5e4a3b2c1d0e",
    "customerId": "cust_1234567890abcdef",
    "externalId": "ext_0987654321fedcba",
    "partnerId": "partner_001",
    "status": "AWAITING_FUNDS",
    "sourceCurrency": "USD",
    "sourceAmount": "1500.00",
    "destinationCurrency": "BTC",
    "destinationAmount": "0.035",
    "transactionType": "ONRAMP",
    "network": "ETHEREUM",
    "depositInstructions": {
      "paymentMethod": "EUR_SEPA",
      "network": "SWIFT",
      "amount": "1500.00",
      "currency": "EUR",
      "fromAddress": "DE89370400440532013000",
      "toAddress": "DE75512108001245126199",
      "depositMessage": "Order 9f8b7c6d5e4a3b2c1d0e deposit",
      "bankName": "Deutsche Bank",
      "bankAddress": "Taunusanlage 12, 60325 Frankfurt am Main, Germany",
      "bankRoutingNumber": "50070024",
      "bankAccountNumber": "1234567890",
      "bankBeneficiaryName": "John Doe",
      "bankBeneficiaryAddress": "123 Main St, Berlin, Germany",
      "iban": "DE89370400440532013000",
      "bic": "DEUTDEFF",
      "clabe": "012345678901234567",
      "accountHolderName": "John Doe",
      "blockchainMemo": "memo123456"
    },
    "customerPaymentDetailsDataId": "cpd_abcdef1234567890",
    "customerWalletDataId": "cwallet_0987654321fedcba",
    "sourceTransactionId": "txsrc_123abc456def7890",
    "destinationTransactionId": "txdest_098def765abc4321",
    "paymentMethod": "USD_WIRE",
    "reason": "Awaiting funds from customer",
    "returnDetails": {
      "reason": "Customer requested refund",
      "refundReferenceId": "refund_20240601_001"
    },
    "createdAt": "2024-06-01T12:00:00Z",
    "updatedAt": "2024-06-01T12:30:00Z"
  }
}

Update the status and details of an order. This is used to progress orders through their lifecycle, such as marking funds as received or providing transaction IDs.

Authentication

X-API-Keystring

API Key authentication via header

Request

This endpoint expects an object.

orderIdstringOptional

statusenumOptional

Optional: new status

sourceTransactionIdstringOptional

Optional: source transaction ID

destinationTransactionIdstringOptional

Optional: destination transaction ID

depositInstructionsobjectOptional

Optional: partner payment details

reasonstringOptional

Required when setting status to ERROR

customerFacingReasonstringOptional

returnDetailsobjectOptional

toAmountstringOptional

Response

Success

orderobject or null

Order message - used for both partner and customer APIs For customer APIs, sensitive fields (customer_id, reason) are not populated