BAbanqzinc
Seeds

Generate test payment requests and transactions for a specific merchant

Changed on

Generate test payment requests and transactions for a specific merchant

post/api/v1/seeds/merchant/{merchantId}/test-data

Request

Path parameters

merchantIdstring uuid required

The merchant ID to generate test data for

Example:934eef9d-2ea7-4a83-9646-cb8ecdc54947

Request body

Example request

{
  "options": {
    "paymentRequestCount": 120,
    "customerCount": 15,
    "dateRangeInDays": 730,
    "includeRefunds": true,
    "includeFailures": true,
    "includePayouts": true
  }
}

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "message": "Test data generated successfully for merchant",
    "summary": {
      "merchantId": "934eef9d-2ea7-4a83-9646-cb8ecdc54947",
      "paymentRequestsCreated": 120,
      "transactionsCreated": 120,
      "customersCreated": 15,
      "timeElapsed": "5.5s"
    },
    "details": {
      "paymentRequestsByStatus": {
        "completed": 84,
        "pending": 18,
        "failed": 12,
        "cancelled": 6
      },
      "transactionsByType": {
        "payment": 120,
        "refund": 0
      },
      "transactionsByStatus": {
        "completed": 84,
        "pending": 18,
        "failed": 12,
        "cancelled": 6
      },
      "amountDistribution": {
        "small": 48,
        "medium": 48,
        "large": 24
      },
      "currencyDistribution": {
        "EUR": 60,
        "GBP": 30,
        "USD": 18,
        "DKK": 12
      }
    }
  }
}

Changes

  • b372e7d5563dRevision changes
    • breaking

      the / response's property type changed from string to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property /

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added subschema #1 subschema #2 to the / response property allOf list for the response status

  • 6637b341d86dRevision changes
    • info

      endpoint added