Postman Collection Guide

1. Click the environment dropdown (top-right)
2. Select "ProBuy Sandbox (Development)"
3. Click the eye icon to view/edit variables
4. Update these variables:

Variable Name          | Value to Update
--------------------- | ---------------------------------
api_token             | YOUR_SANDBOX_API_TOKEN (get from supplier portal)
merchant_success_url  | https://yourstore.com/payment/success
merchant_failure_url  | https://yourstore.com/payment/failure
merchant_cancel_url   | https://yourstore.com/payment/cancel
webhook_url           | https://webhook.site/YOUR_UNIQUE_URL (for testing)

Pre-configured values (no changes needed):
- base_url: https://sandboxapi.probuy.dev
- supplier_portal: https://sandboxsupplier.probuy.dev

Variable Name          | Value to Update
--------------------- | ---------------------------------
api_token             | YOUR_PRODUCTION_API_TOKEN (get from supplier portal)
merchant_success_url  | https://yourstore.com/payment/success
merchant_failure_url  | https://yourstore.com/payment/failure
merchant_cancel_url   | https://yourstore.com/payment/cancel
webhook_url           | https://yourserver.com/webhooks/probuy

Pre-configured values (no changes needed):
- base_url: https://api.probuy.me
- supplier_portal: https://supplier.probuy.me
- company_portal: https://company.probuy.me

POST {{base_url}}/checkout
Authorization: Bearer {{api_token}}
Content-Type: application/json

{
  "orderReferenceId": "ORD-{{$timestamp}}",
  "orderNumber": "ORDER-12345",
  "currency": "SAR",
  "totalAmount": 1500.00,
  "taxAmount": 225.00,
  "consumer": {
    "email": "[email protected]",
    "firstName": "Ahmed",
    "lastName": "Al-Saud",
    "phoneNumber": "+966501234567"
  },
  "billingAddress": {
    "line1": "123 King Fahd Road",
    "city": "Riyadh",
    "state": "Riyadh Province",
    "postalCode": "12345",
    "countryCode": "SA"
  },
  "items": [
    {
      "name": "Test Product",
      "sku": "TEST-001",
      "quantity": 1,
      "unitPrice": 1500.00,
      "totalAmount": 1500.00
    }
  ],
  "countryCode": "SA",
  "merchantUrls": {
    "successUrl": "{{merchant_success_url}}",
    "failureUrl": "{{merchant_failure_url}}",
    "cancelUrl": "{{merchant_cancel_url}}",
    "webhookUrl": "{{webhook_url}}"
  }
}

Tests (Pre-written in collection):
pm.test("Status code is 201", function () {
    pm.response.to.have.status(201);
});

pm.test("Response has checkoutId", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.checkoutId).to.exist;
    pm.environment.set("checkout_id", jsonData.checkoutId);
});

GET {{base_url}}/checkout/{{checkout_id}}
Authorization: Bearer {{api_token}}

Tests:
pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});

pm.test("Checkout has valid status", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.status).to.be.oneOf([
        "pending", "approved", "declined", "cancelled", "expired"
    ]);
});

POST {{base_url}}/eligibility/check
Authorization: Bearer {{api_token}}
Content-Type: application/json

{
  "consumer": {
    "email": "[email protected]",
    "phoneNumber": "+966501234567"
  },
  "amount": 1500.00,
  "currency": "SAR",
  "countryCode": "SA"
}

Tests:
pm.test("Eligibility check returns eligible status", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.eligible).to.be.a('boolean');
    pm.expect(jsonData.maxAmount).to.be.a('number');
});

POST {{base_url}}/checkout/{{checkout_id}}/refund
Authorization: Bearer {{api_token}}
Content-Type: application/json

{
  "amount": 500.00,
  "reason": "Customer requested partial refund",
  "refundType": "partial"
}

Tests:
pm.test("Refund created successfully", function () {
    pm.response.to.have.status(201);
    var jsonData = pm.response.json();
    pm.expect(jsonData.refundId).to.exist;
    pm.environment.set("refund_id", jsonData.refundId);
});

1. Click "..." next to collection name
2. Select "Run collection"
3. Configure runner:
   - Select environment (ProBuy Sandbox)
   - Choose iterations: 1
   - Delay: 1000ms between requests
4. Click "Run ProBuy API Collection"
5. View test results and pass/fail status

# Install Newman
npm install -g newman

# Run collection
newman run probuy-collection.json \
  -e probuy-sandbox-environment.json \
  --reporters cli,html \
  --reporter-html-export ./test-results.html

# Run with specific folder
newman run probuy-collection.json \
  -e probuy-sandbox-environment.json \
  --folder "Checkout Management"

# Run in CI/CD pipeline
newman run probuy-collection.json \
  -e probuy-sandbox-environment.json \
  --bail \
  --reporters cli,junit \
  --reporter-junit-export ./junit-results.xml

// Generate unique order reference
pm.environment.set("order_reference_id", "ORD-" + Date.now());

// Generate random customer email
pm.environment.set("test_email",
  "test-" + Date.now() + "@test.probuy.dev"
);

// Set current timestamp
pm.environment.set("timestamp", new Date().toISOString());

// Calculate tax (15%)
const subtotal = pm.variables.get("subtotal");
const taxAmount = subtotal * 0.15;
pm.environment.set("tax_amount", taxAmount);
pm.environment.set("total_amount", subtotal + taxAmount);

// Webhook signature verification (add to test script)
const crypto = require('crypto');

pm.test("Webhook signature is valid", function () {
    const signature = pm.request.headers.get('X-ProBuy-Signature');
    const body = pm.request.body.raw;
    const secret = pm.environment.get('webhook_secret');

    const expectedSignature = 'sha256=' +
        crypto.createHmac('sha256', secret)
              .update(body)
              .digest('hex');

    pm.expect(signature).to.equal(expectedSignature);
});