Deals

Get list of deals

Retrieves a paginated list of deals (scheduled ONRAMP/OFFRAMP operations) for the specified merchant. Each deal includes its associated orders.

get/api/v1/organizations/{organizationId}/merchants/{merchantId}/deals

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/organizations/{organizationId}/merchants/{merchantId}/deals
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

Organization ID

merchantIdstring required

Merchant ID

Query parameters

pageSize10 | 20 | 50 | 100
Example:10

Number of responses per page

pageNumbernumber
Example:1

Page number

sort'asc' | 'desc'
Example:desc

Ascending or descending order (by creation date)

startDatestring date-time
Example:2024-01-01T00:00:00.000Z

Start date to filter deals (optional)

endDatestring date-time
Example:2024-12-31T23:59:59.999Z

End date to filter deals (optional)

Response

Deals retrieved successfully

totalPagesnumber required

Total number of pages

Example response

{
  "data": [
    {
      "id": "sdeal_123456789",
      "type": "ONRAMP",
      "status": "PENDING",
      "pendingApprovalId": "ppa_123456789",
      "originCurrencySymbol": "CLP",
      "destinationCurrencySymbol": "USDC",
      "amountIn": 97339,
      "amountOut": 100,
      "pendingAmount": 97339,
      "quoteId": "quote_123456789",
      "destinationAccountId": "bacc_destination_123",
      "originAccountId": "bacc_origin_123",
      "destinationAccount": {
        "id": "acc_123456789",
        "name": "My Crypto Wallet",
        "entity": "Polygon",
        "kind": "crypto_wallet",
        "accountNumber": "0x742d35Cc6634C0532925a3b8D402dD81Ca8d8d8",
        "type": "checking",
        "network": "polygon",
        "currencyId": "cur_123456789",
        "currencySymbol": "USDC",
        "address": "0x452d042346864646736ebcc5fbd45c3cffca78eb"
      },
      "originAccount": {
        "id": "acc_123456789",
        "name": "My Crypto Wallet",
        "entity": "Polygon",
        "kind": "crypto_wallet",
        "accountNumber": "0x742d35Cc6634C0532925a3b8D402dD81Ca8d8d8",
        "type": "checking",
        "network": "polygon",
        "currencyId": "cur_123456789",
        "currencySymbol": "USDC",
        "address": "0x452d042346864646736ebcc5fbd45c3cffca78eb"
      },
      "contactId": "con_contact_123",
      "dueDate": "2025-01-28T12:36:55.523Z",
      "createdAt": "2025-01-20T10:30:00.000Z",
      "updatedAt": "2025-01-20T10:30:00.000Z",
      "cryptoDestinationWallet": "0x742d35Cc6634C0532925a3b8D402dD81Ca8d8d8",
      "orders": [
        {
          "id": "ord_123456789",
          "type": "ONRAMP",
          "status": "COMPLETED",
          "amountIn": 100000,
          "amountOut": 100,
          "description": "ONRAMP_DEAL_sdeal_123456789",
          "externalId": "ondeal-1234567890",
          "createdAt": "2025-01-20T10:30:00.000Z",
          "updatedAt": "2025-01-20T10:35:00.000Z"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.